Isso ajuda a instalar um pacote python fooem sua máquina (também pode estar virtualenv) para que você possa importar o pacote foode outros projetos e também dos prompts [I] Python.
Faz o mesmo trabalho de pip, easy_installetc.,
Usando setup.py
Vamos começar com algumas definições:
Pacote - Uma pasta / diretório que contém o __init__.pyarquivo.
Módulo - Um arquivo python válido com .pyextensão.
Distribuição - Como um pacote se relaciona com outros pacotes e módulos .
Digamos que você deseja instalar um pacote chamado foo. Então você faz,
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Em vez disso, se você não deseja realmente instalá-lo, mas ainda deseja usá-lo. Então faça,
$ python setup.py develop
Este comando criará links simbólicos para o diretório de origem nos pacotes de sites em vez de copiar coisas. Por isso, é bastante rápido (principalmente para pacotes grandes).
Criando setup.py
Se você tem sua árvore de pacotes como,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Em seguida, faça o seguinte em seu setup.pyscript para que ele possa ser instalado em alguma máquina:
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
)
Em vez disso, se sua árvore de pacotes for mais complexa como a abaixo:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Então, setup.pynesse caso, você seria como:
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',
]
)
Adicione mais itens a ( setup.py) e torne-o decente:
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',
]
)
O long_descriptioné usado em pypi.org como a descrição README do seu pacote.
E finalmente, agora você está pronto para fazer o upload do seu pacote para o PyPi.org, para que outras pessoas possam instalar o seu pacote usando pip install yourpackage.
O primeiro passo é reivindicar o nome e o espaço do seu pacote no pypi usando:
$ python setup.py register
Depois que o nome do seu pacote estiver registrado, ninguém poderá reivindicá-lo ou usá-lo. Após o registro bem-sucedido, você deve fazer o upload do seu pacote para lá (na nuvem),
$ python setup.py upload
Opcionalmente, você também pode assinar seu pacote com GPG,
$ python setup.py --sign upload
Bônus : Veja uma amostra setup.pyde um projeto real aqui:torchvision-setup.py