Objectifs
Dans cet article nous verrons comment créer une librairie python et l’exposer sur un repository privé que nous mettrons en place. Nous verrons donc les parties suivantes :
- Comment créer sa propre librairie python
- Créer son repository privé
- Préparer son environnement pour l’utilisation de ce repository
A travers ce premier article nous couvrirons la façon dont nous allons créer notre première librairie python.
Création de la librairie
Structure du projet
Pour mettre en place la librairie le projet doit respecter l’arborescence doit respecter la structure suivante :
Le contenu du répertoire du projet est le suivant :
- Le dossier mylib qui contient l’ensemble de code de notre librairie ainsi que le fichier __init__.py permettant à python de considérer le dossier comme contenant des paquets.
- Le fichier README qui contient la description complète de la librairie
- Le fichier MANIFES.in qui liste tous les fichiers non-python de la librairie
- Le fichier setup.py qui contient la fonction setup permettant l’installation de la librairie sur le système.
Le fichier setup.py
Ce fichier contient le méthode setup qui permettra l’installation de la librairie sur le système.
La fonction setup peut prendre en argument une trentaine d’argument, mais voici dans l’exemple ci-dessous ceux qui seront le plus souvent utilisés :
Les premiers paramètres de cette méthode sont surtout des paramètres descriptifs de la librairie, de son auteur, sa licence, sa version …
Concernant les autres paramètres :
- package : contient la liste de tous les packages de la librairie qui seront inséré dans la distribution.
- classifier: Méta donnée permettant aux robots de correctement classer la librairie.
- instal_requires: Cette partie contient toutes les dépendances nécessaires au bon fonctionnement de votre librairie. Dans notre exemple la librairie utilise le connecteur pymongo permettant l’interaction avec les référentiels de données MongoDB
- include_package_data : Permet d’activer la prise en charge du fichier MANIFEST.in
Une fois l’ensemble des ces éléments crée la librairie peut être installée sur le système en utilisant la commande suivante :
$ python setup.py install
Conclusion
Dans cette première partie nous avons vu comment mettre en place notre première librairie Python et à l’installer sur notre environnement. Dans un second article, découvrez comment mettre en place notre propre repository privé et comment préparer notre environnement afin de pouvoir y monter nos librairies afin qu’elles soient utilisable par d’autres personnes.
