Это помогает установить пакет 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