So erstellen und implementieren Sie eine Python-Bibliothek

In der Softwareentwicklung beinhalten viele Projekte sich wiederholende Aufgaben mit identischem Code und identischer Logik. Programmierer schreiben diesen Code ständig neu, was zu Ineffizienzen führt. Beispiele hierfür sind die E-Mail-Validierung oder die Generierung zufälliger Zeichenfolgen.

Eine Lösung besteht darin, diesen Code in wiederverwendbare Bibliotheken zu packen. Diese Bibliotheken werden projektübergreifend installiert und verwendet, wodurch redundante Codierung entfällt. Die meisten sind Open Source und frei verfügbar.

Dies ist in Sprachen wie Python und JavaScript gängige Praxis. Dieses Tutorial beschreibt den Aufbau und die Bereitstellung einer Python-Bibliothek auf PyPI, dem offiziellen Python-Paket-Repository.

Projektübersicht

Dieses Tutorial führt Sie durch die Erstellung und Bereitstellung einer Open-Source-Python-Bibliothek, die mit einer REST-API interagiert.

Die Python-Bibliothek

Die Bibliothek umschließt die Wechselkurs-REST-API der Abstract-API. Diese API bietet drei Endpunkte:

• /live: Ruft Live-Wechselkurse ab.
• /convert: Konvertiert Beträge zwischen Währungen (z. B. 5 USD in GBP).
• /historical: Ruft historische Wechselkurse für einen bestimmten Zeitraum ab.

Diese Bibliothek vereinfacht die API-Interaktion für Entwickler.

Projektanforderungen

Dieses Tutorial setzt Python-Codierungskenntnisse voraus, einschließlich objektorientierter Programmierung (OOP) und Funktionsnutzung. Kenntnisse mit Git, GitHub-Repositories und Projekt-Pushs sind ebenfalls erforderlich.

Tools und Pakete

Sie benötigen:

• Python: Interpreter (>=3.9).
• Anfragen: Zum Stellen von HTTP-Anfragen.
• Zusammenfassung des API-Kontos:Um einen API-Schlüssel zu erhalten (Anweisungen werden bereitgestellt).
• Dotenv: Zur Verwaltung von Umgebungsvariablen.
• Poetry: Ein Python-Abhängigkeitsmanagement- und Verpackungstool.

Erstellen des Projekts

1. Erstellen Sie ein Projektverzeichnis:

   mkdir exchangeLibrary

2. Virtualenv installieren (falls noch nicht installiert):

   pip install virtualenv

3. Navigieren Sie zum Projektverzeichnis:

   cd exchangeLibrary

4. Erstellen und aktivieren Sie eine virtuelle Umgebung:

   virtualenv env

   Aktivieren (Windows): .envScriptsactivate Aktivieren (Linux/macOS): source env/bin/activate

5. Erforderliche Pakete installieren:

   pip install requests poetry dotenv

6. Öffnen Sie das Projekt in einem Code-Editor (PyCharm/VS-Code).

Projektressourcen einrichten

1. Erstellen Sie das Verzeichnis src: Erstellen Sie darin exchange_python, das __init__.py und exchange.py enthält. Ihre Struktur sollte dem Bild unten ähneln:

   

2. Erstellen Sie test.py für Unit-Tests.

3. Besorgen Sie sich Ihren Abstract-API-Schlüssel: A. Melden Sie sich bei Abstract API an. B. Einloggen. C. Navigieren Sie zur Wechselkurs-API. D. Besorgen Sie sich Ihren Primärschlüssel.

4. Erstellen Sie eine .env-Datei: Fügen Sie Ihren API-Schlüssel hinzu:

   mkdir exchangeLibrary

   Ihre Struktur sollte nun so aussehen:

Erstellen des API-Wrappers (exchange.py)

pip install virtualenv

(Die Methoden live, historical und convert bleiben wie in der ursprünglichen Eingabe beschrieben.)

Testen des API-Wrappers (test.py)

1. __init__.py:

   cd exchangeLibrary

2. test.py:

   virtualenv env

3. Führen Sie die Tests durch: Sie sollten ein erfolgreiches Testergebnis sehen.

Bereitstellung des Projekts

1. Erstellen Sie eine .gitignore-Datei: Fügen Sie env, .env hinzu.

2. Erstellen Sie eine README.md Datei.

3. Erstellen pyproject.toml:

   pip install requests poetry dotenv

4. Erstellen Sie ein GitHub-Repository.

5. Git initialisieren: git init

6. Fernbedienung hinzufügen: git remote add origin <your github repo>

7. Aktualisieren Sie pyproject.toml mit Ihrer GitHub-Repo-URL.

8. Push to GitHub.

Bereitstellung auf PyPI

1. Erstellen Sie ein PyPI-Konto und bestätigen Sie Ihre E-Mail-Adresse.
2. 2FA einrichten.
3. Generieren Sie einen Wiederherstellungscode.
4. Verwenden Sie eine Authentifizierungs-App, um den QR-Code zu scannen.
5. Holen Sie sich Ihr API-Token.
6. Erstellen Sie das Paket: poetry build
7. PyPI-Token festlegen: poetry config pypi-token.pypi <your-api-token>
8. Veröffentlichen: poetry publish

Projektwartung

Nach Aktualisierungen Änderungen an GitHub übertragen, erstellen (poetry build) und erneut veröffentlichen (poetry publish), wobei Sie die Version in pyproject.toml nach Bedarf aktualisieren.

Installation und Nutzung

mkdir exchangeLibrary

pip install virtualenv

Fazit

In diesem Tutorial ging es um das Erstellen und Bereitstellen einer Python-Bibliothek für PyPI, einschließlich Aktualisierungen und erneuter Veröffentlichung. Ihr Beitrag zur Open-Source-Community hilft, die Python-Entwicklung zu verbessern.

Das obige ist der detaillierte Inhalt vonSo erstellen und implementieren Sie eine Python-Bibliothek. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!