Nó giúp cài đặt gói python footrên máy của bạn (cũng có thể ở trong virtualenv) để bạn có thể nhập gói footừ các dự án khác và từ [I] nhắc nhở Python.
Nó làm công việc tương tự pip, easy_installv.v.
Sử dụng setup.py
Hãy bắt đầu với một số định nghĩa:
Gói - Một thư mục / thư mục có chứa __init__.pytệp.
Mô-đun - Một tệp python hợp lệ có .pyphần mở rộng.
Phân phối - Làm thế nào một gói liên quan đến các gói và mô-đun khác .
Giả sử bạn muốn cài đặt một gói có tên foo. Sau đó, bạn làm
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Thay vào đó, nếu bạn không thực sự muốn cài đặt nó nhưng vẫn muốn sử dụng nó. Sau đó làm
$ python setup.py develop
Lệnh này sẽ tạo liên kết tượng trưng đến thư mục nguồn trong các gói trang web thay vì sao chép mọi thứ. Bởi vì điều này, nó khá nhanh (đặc biệt đối với các gói lớn).
Tạo setup.py
Nếu bạn có cây gói của bạn như thế nào,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Sau đó, bạn thực hiện các thao tác sau trong setup.pytập lệnh của mình để có thể cài đặt nó trên một số máy:
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
)
Thay vào đó, nếu cây gói của bạn phức tạp hơn như cây dưới đây:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Sau đó, setup.pytrong trường hợp của bạn sẽ như sau:
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',
]
)
Thêm nhiều thứ vào ( setup.py) và làm cho nó đàng hoàng:
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',
]
)
Nó long_descriptionđược sử dụng trong pypi.org như mô tả README của gói của bạn.
Và cuối cùng, giờ bạn đã sẵn sàng để tải gói của bạn lên PyPi.org để những người khác có thể cài đặt gói của bạn bằng cách sử dụng pip install yourpackage.
Bước đầu tiên là yêu cầu tên & không gian gói của bạn bằng pypi bằng cách sử dụng:
$ python setup.py register
Khi tên gói của bạn được đăng ký, không ai có thể yêu cầu hoặc sử dụng nó. Sau khi đăng ký thành công, bạn phải tải gói của mình lên đó (lên đám mây) bằng cách,
$ python setup.py upload
Tùy chọn, bạn cũng có thể ký gói của bạn với GPG,
$ python setup.py --sign upload
Phần thưởng : Xem mẫu setup.pytừ một dự án thực tế tại đây:torchvision-setup.py