Це допомагає встановити пакунок python fooна вашу машину (можна також увійти virtualenv), щоб ви могли імпортувати пакет fooз інших проектів, а також із підказок [I] Python.
Це робить подібну роботу pip, і easy_installт.д.,
Використання setup.py
Почнемо з деяких визначень:
Пакет - папка / каталог, що містить __init__.pyфайл.
Модуль - дійсний файл python з .pyрозширенням.
Розподіл - як один пакет стосується інших пакетів та модулів .
Скажімо, ви хочете встановити пакет з назвою foo. Тоді ти
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Натомість, якщо ви не хочете фактично його встановлювати, але все-таки хочете його використовувати. Тоді зробіть,
$ python setup.py develop
Ця команда створить посилання на вихідний каталог у пакунках сайту замість копіювання речей. Через це він відбувається досить швидко (особливо для великих пакетів).
Створення 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.org, щоб інші могли встановити ваш пакет за допомогоюpip install yourpackage .
Перший крок - заявити назву пакета та простір у pypi, використовуючи:
$ python setup.py register
Після того, як ім’я вашого пакета зареєстровано, ніхто не може його претендувати чи використовувати. Після успішної реєстрації ви повинні завантажити свій пакет туди (до хмари),
$ python setup.py upload
За бажанням ви також можете підписати свій пакет GPG,
$ python setup.py --sign upload
Бонус : Дивіться зразок setup.pyреального проекту тут:torchvision-setup.py