template package importable

Aperçu

Il s'agit du modèle de package que nous utilisons en interne lors de la création de nouveaux packages imporables basés sur Python. Il a toutes les fonctionnalités de base et les workflows nécessaires pour créer, créer et publier un nouveau package sur PYPI.

Ce modèle de package ne fournit aucune fonctionnalité CLI mais est plutôt conçu pour créer des packages imporables.

Nous avons décidé de le rendre disponible avec nos autres outils pour permettre aux gens d'utiliser un point de départ bien conçu lors de la création de leurs propres outils.

Nous fournissons également 2 autres modèles que nous utilisons.

• Template Python Project
• CLI du package de modèle

Caractéristiques

• Architecture modulaire : organiser votre code en modules pour une meilleure maintenabilité.
• Exceptions personnalisées : exemples de base pour implémenter des exceptions personnalisées pour une gestion spécifique des erreurs.
• Exemples de test : Exemples de base pour écrire des tests Pytest pour votre package.

Installation

Pour installer le package imporable, clonez le référentiel et accédez au répertoire du projet:

git clone https://github.com/DevelopersToolbox/template-package-importable.git
cd template-package-importable

Il est recommandé d'utiliser un environnement virtuel pour gérer les dépendances. Vous pouvez créer et activer un environnement virtuel en utilisant les commandes suivantes:

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

Installez les dépendances requises:

pip install -r requirements.txt

Structure du projet

Le projet est organisé comme suit:

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable : contient les modules de base de l'application.
  • exceptions.py : gère les exceptions personnalisées.
  • functions.py : définit quelques exemples de fonctions (pour les tests).
• tests : où se trouvent les tests Pytest.
  • test_template_package_importable.py : les tests spécifiques à exécuter.
• setup.py : la configuration du package.
• requirements.txt : répertorie les dépendances requises pour le projet.
• README.md : le fichier que vous lisez actuellement.