Apprenez à créer votre première bibliothèque Python ! Dans cette série d'articles, nous vous guiderons tout au long du processus de création et de publication d'une bibliothèque Python à l'aide de Poetry. Commençons par créer une petite application de calcul, couvrant tout, de la configuration initiale à la mise en œuvre et au test des fonctions de base. À la fin de cette série, votre bibliothèque sera prête à être partagée avec le monde entier sur PyPI.

Qu’est-ce que la poésie ?

Poetry est un outil de gestion des dépendances et de packaging pour les projets Python. Il simplifie le processus de création et de maintenance des bibliothèques et des applications en automatisant de nombreuses tâches qui nécessitent traditionnellement plusieurs outils. La poésie est livrée avec tous les outils dont vous pourriez avoir besoin pour gérer vos projets de manière déterministe. Voici quelques-uns des principaux avantages de la poésie :

• Créer des projets : créez et emballez vos projets facilement avec une seule commande.
• Partagez votre travail : Faites connaître votre travail en le publiant sur PyPI.
• Vérifiez l'état de vos dépendances : obtenez une vue des dépendances de votre projet avec une seule commande.
• Résolution des dépendances : La poésie est livrée avec un résolveur de dépendances exhaustif, qui trouvera toujours une solution s'il en existe une.
• Isolement : Poetry utilise des environnements virtuels configurés ou crée le sien pour être toujours isolé de votre système.
• CLI intuitive : les commandes Poetry sont intuitives et faciles à utiliser, sensibles par défaut mais configurables.

Avec ces avantages, Poetry s'impose comme un outil puissant et efficace pour développer des projets Python.

De quoi avons-nous besoin avant de démarrer notre bibliothèque Python ?

Avant de commencer à écrire du code, nous devons configurer notre environnement de développement. Voici les étapes pour vous assurer que tout est prêt :

Vérifier la version de Python

Tout d'abord, nous devons nous assurer que la dernière version de Python est installée. Pour vérifier la version de Python installée sur votre système, exécutez la commande suivante dans le terminal :

python --version

Si Python n'est pas déjà installé ou si vous avez besoin de le mettre à jour, vous pouvez le télécharger et l'installer à partir du site Web officiel de Python.

Installer la poésie

Après vous être assuré que la dernière version de Python est installée, l'étape suivante consiste à installer Poetry. Vous pouvez installer Poetry en suivant les instructions détaillées dans la documentation officielle. Voici une commande rapide pour l'installation :

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

Démarrer votre bibliothèque : les premières étapes

Étape 1 : Créer le projet avec Poésie

Maintenant que Python et Poetry sont installés, il est temps de démarrer notre projet de calculatrice. La poésie facilite la création d'un nouveau projet avec une simple commande.

Accédez au répertoire dans lequel vous souhaitez créer votre projet et exécutez la commande suivante dans le terminal :

poetry new calculator
cd calculator

Cette commande crée pour vous une nouvelle structure de projet, qui comprend les dossiers et fichiers essentiels.

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

Comprenons la structure générée :

• README.md : un fichier de documentation pour décrire votre projet.
• calculator/ : Un dossier qui contient le code source de votre application.
• tests/ : un dossier pour vos tests unitaires.
• pyproject.toml : Le fichier de configuration principal de Poetry.

Étape 2 : Implémentation des fonctions de la calculatrice

Créons maintenant les fonctions de calculatrice dans le fichier calculator/calculator.py.

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

Ouvrez le fichier calculator.py et implémentez les fonctions de base de la calculatrice :

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

Étape 3 : tester les fonctions de la calculatrice

Les tests sont essentiels pour garantir la qualité des logiciels, garantissant la fiabilité des corrections de bugs et de l'évolution du code. Dans cet exemple, nous utiliserons des tests unitaires pour valider les fonctions de notre calculatrice. Configurons l'environnement de test et écrivons quelques cas de test pour garantir que les opérations mathématiques fonctionnent correctement.

Configuration de l'environnement de test

Commencez à ajouter pytest en tant que dépendance de développement :

poetry add --dev pytest

Maintenant, créez un fichier appelé test_calculator.py dans le dossier tests :

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)

Enfin, lancez simplement les tests avec la commande suivante :

poetry run pytest

Étape 4 : publication sur GitHub

Maintenant que notre application est couverte de tests, préparons-la à être partagée sur GitHub. Suivez les étapes ci-dessous pour ajouter votre projet à GitHub :

1. Créez un référentiel sur GitHub : accédez à GitHub et créez un nouveau référentiel pour votre calculatrice.

2. Ajoutez votre projet au référentiel :

• Initialisez le dépôt Git dans le répertoire de votre projet s'il n'est pas déjà initialisé :

git init

• Ajoutez tous les fichiers à Git et effectuez le premier commit :

git add .
git commit -m "Initial commit"

• Connectez votre dépôt local au dépôt distant sur GitHub :

git remote add origin 

• Téléchargez vos fichiers sur GitHub :

git push -u origin main

Votre projet est désormais sur GitHub et prêt à être partagé et collaboré avec d'autres développeurs.

Étape 5 : Installation via Pip ou Poetry

Pour installer directement votre bibliothèque, utilisez simplement les commandes suivantes :

• Par Pip :

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

• Via la poésie :

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

Que ce passe t-il après?

Dans cette première partie du tutoriel, nous abordons les fondamentaux essentiels à la création d'une bibliothèque Python à l'aide de Poetry. Nous avons commencé par configurer l'environnement de développement, implémenté une calculatrice de base avec des tests unitaires à l'aide de pytest et partagé le projet sur GitHub pour la collaboration.

Dans la prochaine partie de ce didacticiel, nous explorerons comment publier votre bibliothèque sur PyPI, le référentiel de packages Python standard, et apprendrons comment l'installer à l'aide de Poetry ou pip directement depuis PyPI. Cela rendra non seulement votre bibliothèque plus facile à utiliser pour les autres développeurs, mais cela vous aidera également à vous intégrer à la communauté Python.

Félicitations pour être arrivé jusqu'ici ! J'espère que vous aimez créer votre bibliothèque Python. N'hésitez pas à partager des questions ou des suggestions dans les commentaires. Passons maintenant à la partie II et poursuivons notre parcours de collaboration avec la communauté Python.

Les références

• Canal Eduardo Mendes (@Dunossauro) Création d'un package python à partir de zéro : des exigences au déploiement
• Documentation poétique
• Poésie : créer des packages Python en toute simplicité