Erfahren Sie, wie Sie Ihre erste Python-Bibliothek erstellen! In dieser Beitragsreihe führen wir Sie durch den Prozess der Erstellung und Veröffentlichung einer Python-Bibliothek mit Poetry. Beginnen wir mit der Erstellung einer kleinen Taschenrechneranwendung, die alles von der Erstkonfiguration bis zur Implementierung und dem Testen grundlegender Funktionen abdeckt. Am Ende dieser Serie können Sie Ihre Bibliothek auf PyPI mit der Welt teilen.

Was ist Poesie?

Poetry ist ein Abhängigkeitsmanagement- und Paketierungstool für Python-Projekte. Es vereinfacht den Prozess der Erstellung und Pflege von Bibliotheken und Anwendungen durch die Automatisierung vieler Aufgaben, für die traditionell mehrere Tools erforderlich sind. Poetry enthält alle Tools, die Sie für die deterministische Verwaltung Ihrer Projekte benötigen. Hier sind einige der Hauptvorteile der Poesie:

• Projekte erstellen: Erstellen und verpacken Sie Ihre Projekte ganz einfach mit einem einzigen Befehl.
• Teilen Sie Ihre Arbeit: Machen Sie Ihre Arbeit bekannt, indem Sie sie auf PyPI veröffentlichen.
• Überprüfen Sie den Status Ihrer Abhängigkeiten: Erhalten Sie mit nur einem Befehl einen Überblick über die Abhängigkeiten Ihres Projekts.
• Abhängigkeitsauflösung: Poetry verfügt über einen umfassenden Abhängigkeitslöser, der immer eine Lösung findet, falls vorhanden.
• Isolation: Poetry nutzt konfigurierte virtuelle Umgebungen oder erstellt eigene, um immer von Ihrem System isoliert zu sein.
• Intuitive CLI: Poetry-Befehle sind intuitiv und einfach zu verwenden, standardabhängig und dennoch konfigurierbar.

Mit diesen Vorteilen zeichnet sich Poetry als leistungsstarkes und effizientes Werkzeug für die Entwicklung von Python-Projekten aus.

Was brauchen wir, bevor wir unsere Python-Bibliothek starten?

Bevor wir mit dem Schreiben von Code beginnen, müssen wir unsere Entwicklungsumgebung einrichten. Hier sind die Schritte, um sicherzustellen, dass Sie alles bereit haben:

Überprüfen Sie die Python-Version

Zuerst müssen wir sicherstellen, dass Sie die neueste Version von Python installiert haben. Um die auf Ihrem System installierte Python-Version zu überprüfen, führen Sie den folgenden Befehl im Terminal aus:

python --version

Wenn Sie Python noch nicht installiert haben oder es aktualisieren müssen, können Sie es von der offiziellen Python-Website herunterladen und installieren.

Poesie installieren

Nachdem Sie sichergestellt haben, dass Sie die neueste Version von Python installiert haben, besteht der nächste Schritt darin, Poetry zu installieren. Sie können Poetry installieren, indem Sie den Anweisungen in der offiziellen Dokumentation folgen. Hier ist ein schneller Befehl zur Installation:

curl -sSL https://install.python-poetry.org | python3 -

Starten Sie Ihre Bibliothek: Die ersten Schritte

Schritt 1: Erstellen des Projekts mit Poetry

Da wir nun Python und Poetry installiert haben, ist es an der Zeit, unser Rechnerprojekt zu starten. Poetry macht es einfach, mit einem einfachen Befehl ein neues Projekt zu erstellen.

Navigieren Sie zu dem Verzeichnis, in dem Sie Ihr Projekt erstellen möchten, und führen Sie den folgenden Befehl im Terminal aus:

poetry new calculator
cd calculator

Dieser Befehl erstellt für Sie eine neue Projektstruktur, die wichtige Ordner und Dateien enthält.

calculator/
├── README.md
├── calculator
│   └── __init__.py
├── pyproject.toml
└── tests
    └── __init__.py

Lassen Sie uns die generierte Struktur verstehen:

• README.md: Eine Dokumentationsdatei zur Beschreibung Ihres Projekts.
• calculator/: Ein Ordner, der den Quellcode Ihrer Anwendung enthält.
• tests/: Ein Ordner für Ihre Unit-Tests.
• pyproject.toml: Die Hauptkonfigurationsdatei für Poetry.

Schritt 2: Implementierung der Rechnerfunktionen

Jetzt erstellen wir die Taschenrechnerfunktionen in der Datei „calculator/calculator.py“.

calculator/
├── calculator.py
├── __init__.py

Öffnen Sie die Datei „calculator.py“ und implementieren Sie die grundlegenden Taschenrechnerfunktionen:

def add(a, b):
    return a   b

def subtract(a, b):
    return a - b

def multiply(a, b):
    return a * b

def divide(a, b):
    if b == 0:
        raise ValueError("Não é possível dividir por zero")
    return a / b

Schritt 3: Testen der Rechnerfunktionen

Testen ist unerlässlich, um die Softwarequalität zu gewährleisten und Zuverlässigkeit bei der Fehlerbehebung und Codeentwicklung zu gewährleisten. In diesem Beispiel verwenden wir Unit-Tests, um unsere Taschenrechnerfunktionen zu validieren. Lassen Sie uns die Testumgebung einrichten und einige Testfälle schreiben, um sicherzustellen, dass die mathematischen Operationen korrekt funktionieren.

Konfigurieren der Testumgebung

Beginnen Sie mit dem Hinzufügen von Pytest als Entwicklungsabhängigkeit:

poetry add --dev pytest

Erstellen Sie nun eine Datei namens test_calculator.py im Testordner:

import pytest
from calculator.calculator import add, subtract, multiply, divide

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(-1, -1) == -2

def test_subtract():
    assert subtract(5, 2) == 3
    assert subtract(0, 0) == 0
    assert subtract(-1, 1) == -2
    assert subtract(-1, -1) == 0

def test_multiply():
    assert multiply(2, 3) == 6
    assert multiply(5, 0) == 0
    assert multiply(-1, 1) == -1
    assert multiply(-2, -3) == 6

def test_divide():
    assert divide(6, 2) == 3
    assert divide(5, 2) == 2.5
    assert divide(-10, 2) == -5
    with pytest.raises(ValueError):
        divide(4, 0)

Zum Schluss führen Sie die Tests einfach mit dem folgenden Befehl aus:

poetry run pytest

Schritt 4: Veröffentlichung auf GitHub

Da unsere Anwendung nun mit Tests abgedeckt ist, bereiten wir sie für die Freigabe auf GitHub vor. Führen Sie die folgenden Schritte aus, um Ihr Projekt zu GitHub hinzuzufügen:

1. Erstellen Sie ein Repository auf GitHub: Gehen Sie zu GitHub und erstellen Sie ein neues Repository für Ihren Rechner.

2. Fügen Sie Ihr Projekt zum Repository hinzu:

• Initialisieren Sie das Git-Repository in Ihrem Projektverzeichnis, falls es noch nicht initialisiert ist:

git init

• Fügen Sie alle Dateien zu Git hinzu und führen Sie den ersten Commit durch:

git add .
git commit -m "Initial commit"

• Verbinden Sie Ihr lokales Repository mit dem Remote-Repository auf GitHub:

git remote add origin 

• Laden Sie Ihre Dateien auf GitHub hoch:

git push -u origin main

Jetzt ist Ihr Projekt auf GitHub und kann mit anderen Entwicklern geteilt und gemeinsam bearbeitet werden.

Schritt 5: Installation über Pip oder Poetry

Um Ihre Bibliothek direkt zu installieren, verwenden Sie einfach die folgenden Befehle:

• Über Pip:

pip install git https://github.com/seu_usuario/seu_repositorio.git

• Über Poesie:

poetry add git https://github.com/seu_usuario/seu_repositorio.git

Was kommt als nächstes?

In diesem ersten Teil des Tutorials behandeln wir die wesentlichen Grundlagen zum Erstellen einer Python-Bibliothek mit Poetry. Wir begannen mit der Einrichtung der Entwicklungsumgebung, implementierten einen einfachen Rechner mit Komponententests mithilfe von Pytest und teilten das Projekt zur Zusammenarbeit auf GitHub.

Im nächsten Teil dieses Tutorials erfahren Sie, wie Sie Ihre Bibliothek in PyPI, dem Standard-Python-Paket-Repository, veröffentlichen und wie Sie sie mit Poetry oder Pip direkt aus PyPI installieren. Dies erleichtert nicht nur die Verwendung Ihrer Bibliothek für andere Entwickler, sondern hilft Ihnen auch bei der Integration in die Python-Community.

Herzlichen Glückwunsch, dass Sie so weit gekommen sind! Ich hoffe, dass Ihnen die Erstellung Ihrer Python-Bibliothek Spaß macht. Teilen Sie Fragen oder Anregungen gerne in den Kommentaren mit. Kommen wir nun zu Teil II und setzen unsere Reise der Zusammenarbeit mit der Python-Community fort.

Verweise

• Canal Eduardo Mendes (@Dunossauro) Erstellen eines Python-Pakets von Grund auf: von den Anforderungen bis zur Bereitstellung
• Lyrikdokumentation
• Poesie: Python-Pakete einfach erstellen