So hosten Sie Ihr Python-Paket auf PyPI mit GitHub

PyPI ist der offizielle Index für Python-Pakete. Sobald Sie es auf PyPI veröffentlicht haben, kann es über einen einfachen Befehl heruntergeladen werden pip install <package>. Mit dieser einen Linie wird das Leben einfacher.

1: Erstellen Sie Konten

Um Ihr Paket auf PyPI einzureichen, müssen Sie einige Konten auf der PyPI-Website haben. Diese Konten ermöglichen es Ihnen, Ihre Pakete zu verwalten, und stellen Ihnen eine Schnittstelle zum Bearbeiten Ihres Pakets zur Verfügung.

Erstellen Sie Ihr Konto auf folgenden Websites:

2: Die .pypirc Datei

Erstellen Sie nun eine Datei in Ihrem Home-Ordner mit dem Namen .pypircdie Ihre Konfigurationsdatei sein wird, die die Authentifizierungsinformationen Ihrer PyPI-Konten enthält.

Erstellen Sie eine Datei .pypirc und legen Sie den unten gezeigten Inhalt ein

vim ~/.pypirc

.pypirc Dateiinhalt

[distutils]
index-servers =
  pypi
  pypitest

[pypi]
repository: 
username: YOUR_USERNAME_HERE
password: YOUR_PASSWORD_HERE

[pypitest]
repository: 
username: YOUR_USERNAME_HERE
password: YOUR_PASSWORD_HERE

Sie sollten ersetzen YOUR_USERNAME_HERE und YOUR_PASSWORD_HERE mit Ihrem Benutzernamen und Passwort von PyPI-Sites, die Sie gerade erstellt haben.

3: Die Verzeichnisstruktur des Python-Pakets

  • source_dir ist ein Stammverzeichnis, das Ihr Python-Paket enthält
  • my_python_package ist Ihr Haupt-Python-Paket, das Sie veröffentlichen möchten
source_dir/                 # the source directory
|-- my_python_package       # your package
|   |-- __init__.py
|   `-- FILES ....          # your package files
|-- README.md
|-- setup.cfg
|-- setup.py

Richten Sie Ihre Verzeichnisstruktur wie oben gezeigt mit den entsprechenden Änderungen ein und hosten Sie sie github.com.

Dieser Schritt beinhaltet die Veröffentlichung Ihres Pakets auf GitHub. Dadurch wird ein Download-Link Ihrer vollständigen Quelle erstellt. Um Ihr GitHub-Projekt freizugeben, müssen Sie die folgenden Schritte ausführen:

  1. Rufen Sie Ihre Projekthomepage auf auf GitHub
  2. Oben sehen Sie Link freigeben. Klick es an.
  3. Klicke auf Entwerfen Sie eine neue Version
  4. Füllen Sie alle Details aus
    • Tag-Version sollte die Versionsnummer Ihrer Paketfreigabe sein
    • Titel freigeben kann alles sein, was du willst.
  5. Klicken Freigabe veröffentlichen am Ende der Seite
  6. Jetzt unter Freigaben Sie können alle Ihre Veröffentlichungen anzeigen.
  7. Kopieren Sie den Download-Link (tar.gz) und speichern Sie ihn irgendwo.

5: Bearbeiten von Dateien

Öffne das setup.py Datei und fügen Sie das folgende Skelett hinzu

from distutils.core import setup

setup(
    name = 'my_python_package',
    packages = ['my_python_package'],
    version = 'version number',  
    description = 'description',
    author = '',
    author_email = '',
    url = 'github package source url',
    download_url = 'download link you saved',
    keywords = ['tag1', 'tag2'],
    classifiers = [],
)

Öffne das setup.cfg Datei und fügen Sie das folgende Skelett hinzu

[metadata]
description-file = README.md

Jetzt alles auf GitHub pushen.

6: Veröffentlichen Sie das Paket

Führen Sie die folgenden Befehle aus

python setup.py register -r pypitest

Dieser Befehl versucht, Ihr Paket auf dem PyPI-Testserver zu registrieren. Dadurch wird sichergestellt, dass alles, was Sie eingerichtet haben, korrekt ist.

python setup.py sdist upload -r pypitest

Dieser Befehl lädt Ihr Paket in das Test-Repository hoch und jetzt sollten Sie Ihr Paket sehen PyPI-Test

Jetzt können Sie Ihr Paket auf PyPI Live Server veröffentlichen! Führen Sie die folgenden Befehle aus

python setup.py register -r pypi
python setup.py sdist upload -r pypi

Herzliche Glückwünsche! Sie haben gerade Ihr Python-Paket auf PyPI veröffentlicht

Bezug: Offizielle Dokumentation

Similar Posts

Leave a Reply

Your email address will not be published. Required fields are marked *