Cela aide à installer un package python foosur votre machine (peut également l'être virtualenv) afin que vous puissiez importer le package à foopartir d'autres projets et également à partir des invites [I] Python.
Il fait le travail similaire de pip, easy_installetc.,
En utilisant setup.py
Commençons par quelques définitions:
Package - Un dossier / répertoire qui contient un __init__.pyfichier.
Module - Un fichier python valide avec une .pyextension.
Distribution - Lien entre un package et d'autres packages et modules .
Supposons que vous souhaitiez installer un package nommé foo. Alors tu fais,
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Au lieu de cela, si vous ne souhaitez pas réellement l'installer mais souhaitez tout de même l'utiliser. Alors fais,
$ python setup.py develop
Cette commande créera des liens symboliques vers le répertoire source dans les packages de site au lieu de copier des choses. Pour cette raison, il est assez rapide (en particulier pour les gros colis).
Créer setup.py
Si vous avez votre arborescence de packages comme,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Ensuite, vous effectuez les opérations suivantes dans votre setup.pyscript afin qu'il puisse être installé sur une machine:
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
)
Au lieu de cela, si votre arborescence de packages est plus complexe comme celle ci-dessous:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Ensuite, votre setup.pydans ce cas serait comme:
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',
]
)
Ajoutez plus de choses à ( setup.py) et rendez-le décent:
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',
]
)
Le long_descriptionest utilisé dans pypi.org comme description README de votre paquet.
Et enfin, vous êtes maintenant prêt à télécharger votre package sur PyPi.org afin que d'autres puissent installer votre package à l'aide pip install yourpackage.
La première étape consiste à réclamer le nom et l'espace de votre package dans pypi en utilisant:
$ python setup.py register
Une fois le nom de votre colis enregistré, personne ne peut le réclamer ou l'utiliser. Après une inscription réussie, vous devez y télécharger votre package (dans le cloud) par,
$ python setup.py upload
En option, vous pouvez également signer votre colis avec GPGpar,
$ python setup.py --sign upload
Bonus : Voir un échantillon setup.pyd'un vrai projet ici:torchvision-setup.py