Comment Générer en deux minutes une Librairie en Python : Guide Pratique et trivial

Si vous avez déjà cherché des informations sur la génération de librairies en Python, vous avez peut-être constaté que les ressources disponibles ne sont pas toujours claires ou faciles à suivre. C'est pourquoi j'ai décidé d'écrire cet article pour vous guider à travers les étapes de création et de génération d'une librairie Python de manière simple et efficace.

Structure de Projet

Pour commencer, supposons que votre projet ait la structure suivante :

mon_projet/
├── src/
│   └── pytools/
│       └── __init__.py
├── tests/
│   └── test_pytools.py
└── setup.py
    

• src/ : Contient le code source de votre librairie.
• tests/ : Contient les tests pour votre librairie.
• setup.py : Le fichier de configuration pour générer le package.

Création du Fichier setup.py

Le fichier setup.py est essentiel pour définir les métadonnées de votre librairie et pour spécifier comment elle doit être construite et installée. Voici un exemple de ce à quoi il pourrait ressembler :

from setuptools import setup, find_packages

setup(
    name="pytools",
    version="0.1.0",
    packages=find_packages(where="src"),
    package_dir={"pytools":"src/pytools"},
    description="Une librairie privée",
    author="Yannick Beynet",
    python_requires=">=3.12",
)

    

Dans cet exemple :

• name : Le nom de votre librairie.
• version : La version actuelle de votre librairie.
• packages : Utilise find_packages pour trouver les packages dans le dossier src.
• package_dir : Spécifie que les packages sont dans le dossier src.
• description : Une courte description de votre librairie.
• author : Le nom de l'auteur.
• python_requires : Indique la version minimum de Python requise.

Générer le Package

Une fois que votre fichier setup.py est en place, vous pouvez générer votre package en utilisant la commande suivante :

python -m build

Cette commande créera un fichier .whl (Wheel) et un fichier .tar.gz dans un dossier dist de votre projet. Ces fichiers sont les distributions de votre package, que vous pouvez ensuite distribuer et installer.

Le package généré se trouve dans le dossier dist. Vous pouvez l'installer en ligne de commande avec pip en utilisant la commande suivante :

pip install dist/pytools-0.1.0-py3-none-any.whl

Conclusion

Et voilà ! Vous avez maintenant un package Python prêt à être partagé. En suivant ces étapes simples, vous pouvez créer et distribuer vos propres librairies Python. N'oubliez pas de toujours tester votre code et de documenter vos fonctionnalités pour rendre votre librairie facile à utiliser par d'autres développeurs.

Si vous avez des questions ou des suggestions, n'hésitez pas à les laisser dans les commentaires ci-dessous. Bonne programmation !