Es ist hilfreich, ein Python-Paket fooauf Ihrem Computer zu installieren (kann auch vorhanden sein virtualenv), damit Sie das Paket fooaus anderen Projekten und auch aus [I] Python-Eingabeaufforderungen importieren können .
Es macht den ähnlichen Job pip, easy_installusw.,
Verwenden von setup.py
Beginnen wir mit einigen Definitionen:
Paket - Ein Ordner / Verzeichnis, das eine __init__.pyDatei enthält .
Modul - Eine gültige Python-Datei mit der .pyErweiterung.
Verteilung - Wie sich ein Paket auf andere Pakete und Module bezieht .
Angenommen, Sie möchten ein Paket mit dem Namen installieren foo. Dann tust du es
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Stattdessen, wenn Sie es nicht tatsächlich installieren möchten, es aber dennoch verwenden möchten. Dann mach,
$ python setup.py develop
Dieser Befehl erstellt Symlinks zum Quellverzeichnis innerhalb von Site-Paketen, anstatt Dinge zu kopieren. Aus diesem Grund ist es ziemlich schnell (insbesondere für große Pakete).
Erstellen setup.py
Wenn Sie Ihren Paketbaum mögen,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Anschließend führen Sie in Ihrem setup.pySkript Folgendes aus, damit es auf einem Computer installiert werden kann:
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
)
Wenn Ihr Paketbaum komplexer ist als der folgende:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Dann wäre Ihr setup.pyin diesem Fall wie folgt:
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',
]
)
Füge mehr Zeug zu ( setup.py) hinzu und mache es anständig:
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',
]
)
Das long_descriptionwird in pypi.org als README-Beschreibung Ihres Pakets verwendet.
Und schließlich können Sie Ihr Paket jetzt auf PyPi.org hochladen, damit andere Ihr Paket mithilfe von installieren könnenpip install yourpackage .
Der erste Schritt besteht darin, Ihren Paketnamen und Speicherplatz in pypi mit folgenden Angaben zu beanspruchen:
$ python setup.py register
Sobald Ihr Paketname registriert ist, kann niemand ihn beanspruchen oder verwenden. Nach erfolgreicher Registrierung müssen Sie Ihr Paket dort (in die Cloud) hochladen durch,
$ python setup.py upload
Optional können Sie Ihr Paket auch mit unterschreiben GPG,
$ python setup.py --sign upload
Bonus : Sehen Sie hier ein Beispiel setup.pyaus einem realen Projekt:torchvision-setup.py