Comment créer et déployer une bibliothèque Python

Dans le développement de logiciels, de nombreux projets impliquent des tâches répétitives utilisant un code et une logique identiques. Les programmeurs réécrivent constamment ce code, créant des inefficacités. Les exemples incluent la validation d'e-mail ou la génération de chaînes aléatoires.

Une solution consiste à empaqueter ce code dans des bibliothèques réutilisables. Ces bibliothèques sont installées et utilisées dans tous les projets, éliminant ainsi le codage redondant. La plupart sont open source et disponibles gratuitement.

Il s'agit d'une pratique courante dans des langages comme Python et JavaScript. Ce didacticiel détaille la création et le déploiement d'une bibliothèque Python sur PyPI, le référentiel officiel de packages Python.

Aperçu du projet

Ce didacticiel vous guide dans la création et le déploiement d'une bibliothèque Python open source qui interagit avec une API REST.

La bibliothèque Python

La bibliothèque encapsulera l'API REST Exchange Rates de l'API Abstract. Cette API propose trois points de terminaison :

• /live : Récupère les taux de change en direct.
• /convert : convertit les montants entre les devises (par exemple, 5 USD en GBP).
• /historical : Récupère les taux de change historiques pour une période spécifiée.

Cette bibliothèque simplifie l'interaction API pour les développeurs.

Exigences du projet

Ce didacticiel suppose une maîtrise du codage Python, y compris la programmation orientée objet (POO) et l'utilisation des fonctions. Une connaissance de Git, des référentiels GitHub et des poussées de projets est également nécessaire.

Outils et packages

Vous aurez besoin de :

• Python : Interprète (>=3.9).
• Demandes : Pour effectuer des requêtes HTTP.
• Compte API abstrait :Pour obtenir une clé API (instructions fournies).
• Dotenv : Pour gérer les variables d'environnement.
• Poésie : Un outil de gestion et de packaging des dépendances Python.

Création du projet

1. Créer un répertoire de projet :

   mkdir exchangeLibrary

2. Installer virtualenv (s'il n'est pas déjà installé) :

   pip install virtualenv

3. Accédez au répertoire du projet :

   cd exchangeLibrary

4. Créer et activer un environnement virtuel :

   virtualenv env

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

5. Installer les packages requis :

   pip install requests poetry dotenv

6. Ouvrez le projet dans un éditeur de code (PyCharm/VS Code).

Configuration des ressources du projet

1. Créez le répertoire src : À l'intérieur, créez exchange_python contenant __init__.py et exchange.py. Votre structure doit ressembler à l'image ci-dessous :

   

2. Créez test.py pour les tests unitaires.

3. Obtenez votre clé API abstraite : un. Inscrivez-vous sur l'API abstraite. b. Se connecter. c. Accédez à l'API des taux de change. d. Obtenez votre clé primaire.

4. Créez un .env fichier : Ajoutez votre clé API :

   mkdir exchangeLibrary

   Votre structure devrait maintenant ressembler à ceci :

Création du wrapper API (exchange.py)

pip install virtualenv

(Les méthodes live, historical et convert restent telles que décrites dans l'entrée d'origine.)

Test du wrapper API (test.py)

1. __init__.py :

   cd exchangeLibrary

2. test.py :

   virtualenv env

3. Exécutez les tests : Vous devriez voir un résultat de test réussi.

Déploiement du projet

1. Créer un fichier .gitignore : Ajouter env, .env.

2. Créez un fichier README.md.

3. Créer pyproject.toml :

   pip install requests poetry dotenv

4. Créez un référentiel GitHub.

5. Initialiser Git : git init

6. Ajouter une télécommande : git remote add origin <your github repo>

7. Mettez à jour pyproject.toml avec l'URL de votre dépôt GitHub.

8. Poussez vers GitHub.

Déploiement sur PyPI

1. Créez un compte PyPI et vérifiez votre adresse e-mail.
2. Configurez 2FA.
3. Générez un code de récupération.
4. Utilisez une application d'authentification pour scanner le code QR.
5. Obtenez votre jeton API.
6. Construire le package : poetry build
7. Définissez le jeton PyPI : poetry config pypi-token.pypi <your-api-token>
8. Publier : poetry publish

Maintenance du projet

Après les mises à jour, transférez les modifications vers GitHub, construisez (poetry build) et republiez (poetry publish), en mettant à jour la version dans pyproject.toml si nécessaire.

Installation et utilisation

mkdir exchangeLibrary

pip install virtualenv

Conclusion

Ce tutoriel couvrait la création et le déploiement d'une bibliothèque Python sur PyPI, y compris les mises à jour et la republication. Votre contribution à la communauté open source contribue à améliorer le développement de Python.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!