ช่วยในการติดตั้งแพ็กเกจหลามfooบนเครื่องของคุณ (สามารถอยู่ในvirtualenv) เพื่อให้คุณสามารถนำเข้าแพคเกจfooจากโครงการอื่น ๆ และจาก [I] แจ้งให้หลาม
มันไม่งานของที่คล้ายกันpip, easy_installฯลฯ
การใช้ setup.py
เริ่มด้วยคำจำกัดความบางอย่าง:
แพ็คเกจ - โฟลเดอร์ / ไดเรกทอรีที่มี__init__.pyไฟล์
Module - ไฟล์ python ที่ถูกต้องพร้อม.pyส่วนขยาย
การแจกจ่าย - แพคเกจหนึ่งเกี่ยวข้องกับแพ็คเกจและโมดูลอื่นอย่างไรอื่นอย่างไร
fooสมมติว่าคุณต้องการติดตั้งแพคเกจที่มีชื่อว่า จากนั้นคุณทำ
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
แต่ถ้าคุณไม่ต้องการติดตั้งจริง แต่ก็ยังต้องการใช้งาน จากนั้นทำ
$ python setup.py develop
คำสั่งนี้จะสร้าง symlink ไปยังไดเรกทอรีต้นทางภายในไซต์แพ็คเกจแทนที่จะคัดลอกสิ่งต่าง ๆ ด้วยเหตุนี้มันค่อนข้างเร็ว (โดยเฉพาะสำหรับแพ็คเกจขนาดใหญ่)
การสร้าง setup.py
หากคุณมีแผนผังแพ็คเกจเช่น
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
จากนั้นคุณทำสิ่งต่อไปนี้ในsetup.pyสคริปต์ของคุณเพื่อให้สามารถติดตั้งในเครื่องบางเครื่องได้:
from setuptools import setup
setup(
name='foo',
version='1.0',
description='A useful module',
author='Man Foo',
author_email='foomail@foo.com',
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
)
แต่ถ้าทรีแพ็กเกจของคุณซับซ้อนกว่าเช่นด้านล่าง:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
จากนั้นsetup.pyในกรณีนี้จะเป็นดังนี้:
from setuptools import setup
setup(
name='foo',
version='1.0',
description='A useful module',
author='Man Foo',
author_email='foomail@foo.com',
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
scripts=[
'scripts/cool',
'scripts/skype',
]
)
เพิ่มสิ่งอื่น ๆ ลงใน ( setup.py)และทำให้เหมาะสม:
from setuptools import setup
with open("README", 'r') as f:
long_description = f.read()
setup(
name='foo',
version='1.0',
description='A useful module',
license="MIT",
long_description=long_description,
author='Man Foo',
author_email='foomail@foo.com',
url="http://www.foopackage.com/",
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
scripts=[
'scripts/cool',
'scripts/skype',
]
)
long_descriptionใช้ในpypi.orgเป็นคำอธิบาย README ของแพคเกจของคุณ
และในที่สุดขณะนี้คุณพร้อมที่จะอัปโหลดแพคเกจของคุณเพื่อPyPi.orgpip install yourpackageเพื่อให้ผู้อื่นสามารถติดตั้งแพคเกจของคุณโดยใช้
ขั้นตอนแรกคืออ้างสิทธิ์ชื่อแพ็คเกจ & พื้นที่ใน pypi โดยใช้:
$ python setup.py register
เมื่อลงทะเบียนชื่อแพ็คเกจของคุณแล้วจะไม่มีใครสามารถเรียกร้องหรือใช้มันได้ หลังจากลงทะเบียนเรียบร้อยแล้วคุณต้องอัปโหลดแพ็คเกจของคุณที่นั่น (ไปยังคลาวด์) โดย
$ python setup.py upload
คุณยังสามารถลงนามในแพ็คเกจของคุณด้วยGPGโดย
$ python setup.py --sign upload
โบนัส : ดูตัวอย่างsetup.pyจากโครงการจริงที่นี่:torchvision-setup.py