Ayuda a instalar un paquete de Python fooen su máquina (también puede estar en virtualenv) para que pueda importar el paquete foodesde otros proyectos y también desde las indicaciones de [I] Python.
Hace el trabajo similar de pip, easy_installetc.,
Utilizando setup.py
Comencemos con algunas definiciones:
Paquete : una carpeta / directorio que contiene el __init__.pyarchivo.
Módulo : un archivo Python válido con .pyextensión.
Distribución : cómo se relaciona un paquete con otros paquetes y módulos .
Digamos que desea instalar un paquete llamado foo. Entonces lo haces
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
En cambio, si no desea instalarlo realmente, pero aún así desea utilizarlo. Entonces hazlo,
$ python setup.py develop
Este comando creará enlaces simbólicos al directorio fuente dentro de los paquetes del sitio en lugar de copiar cosas. Debido a esto, es bastante rápido (particularmente para paquetes grandes).
Creando setup.py
Si tienes tu árbol de paquetes como,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Luego, hace lo siguiente en su setup.pyscript para que pueda instalarse en alguna 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
)
En cambio, si su árbol de paquetes es más complejo como el siguiente:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Entonces, su setup.pyen este caso sería 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',
]
)
Agregue más cosas a ( setup.py) y hágalo 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',
]
)
Se long_descriptionutiliza en pypi.org como la descripción README de su paquete.
Y finalmente, ahora está listo para cargar su paquete en PyPi.org para que otros puedan instalar su paquete usando pip install yourpackage.
El primer paso es reclamar el nombre del paquete y el espacio en pypi usando:
$ python setup.py register
Una vez que se registra el nombre de su paquete, nadie puede reclamarlo ni utilizarlo. Después de un registro exitoso, debe cargar su paquete allí (a la nube),
$ python setup.py upload
Opcionalmente, también puede firmar su paquete con GPG,
$ python setup.py --sign upload
Bonificación : vea una muestra setup.pyde un proyecto real aquí:torchvision-setup.py