So erstellen und veröffentlichen Sie ein Python-Paket

Durch das Erstellen und Veröffentlichen eines Python-Pakets können Sie Ihren Code mit der breiteren Python-Community teilen. In dieser Anleitung führen wir Sie durch die Schritte zum Erstellen eines Python-Pakets und veröffentlichen es im Python Package Index (PyPI), wo andere es einfach installieren und verwenden können.

Einrichten Ihres Projekts

Bevor Sie beginnen, stellen Sie sicher, dass Python auf Ihrem System installiert ist. Sie müssen außerdem die Pakete setuptools und wheel installieren, falls Sie dies noch nicht getan haben:

pip install setuptools wheel

Erstellen der Paketstruktur

Erstellen Sie ein neues Verzeichnis für Ihr Paketprojekt. Erstellen Sie in diesem Verzeichnis die folgende Struktur:

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

Hier ist ein kurzer Überblick über diese Dateien:

• your_package/__init__.py: Markiert das Verzeichnis als Python-Paket.
• your_package/module1.py und your_package/module2.py: Ihre Paketmodule.
• tests/: Verzeichnis für die Testfälle Ihres Pakets.
• setup.py: Das Build-Skript für Ihr Paket.
• README.md: Eine Datei, die erklärt, was Ihr Paket macht.
• LICENSE: Die Lizenzdatei Ihres Pakets.

Schreiben des Setup-Skripts

Die Datei setup.py ist wichtig, um die Metadaten und Abhängigkeiten Ihres Pakets zu definieren. Hier ist ein einfaches Beispiel:

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='[email protected]',
    license='MIT',
)

Erstellen einer README-Datei

Die Datei README.md sollte einen Überblick über Ihr Paket bieten, einschließlich der Installations- und Verwendungshinweise. Hier ist ein Beispiel:

# Your Package

A brief description of your package.

Installation

pip install your_package

Verwendung

import your_package

# Example usage

Erstellen des Pakets

Navigieren Sie zu Ihrem Projektverzeichnis und führen Sie den folgenden Befehl aus, um Ihr Paket zu erstellen:

python setup.py sdist bdist_wheel

Dieser Befehl erstellt Verteilungsarchive im Verzeichnis dist/.

Veröffentlichen auf PyPI

Um Ihr Paket zu veröffentlichen, benötigen Sie ein Konto bei PyPI. Wenn Sie keins haben, erstellen Sie es unter PyPI.

Installieren Sie als Nächstes das Paket twine:

pip install twine

Verwenden Sie twine, um Ihr Paket auf PyPI hochzuladen:

twine upload dist/*

Sie werden nach Ihrem PyPI-Benutzernamen und -Passwort gefragt. Nach einem erfolgreichen Upload ist Ihr Paket auf PyPI verfügbar.

Abschluss

Herzlichen Glückwunsch! Sie haben jetzt Ihr Python-Paket erstellt und veröffentlicht. Andere können es mit pip installieren und Sie können es weiterhin aktualisieren und verbessern. Denken Sie daran, Ihr Paket zu pflegen, indem Sie die Versionsnummer aktualisieren und neue Versionen hochladen, wenn Sie Änderungen vornehmen.