template package cli

Aperçu

Il s'agit du modèle de package que nous utilisons en interne lors de la création de nouveaux outils basés sur Python CLI. 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 package fournit un utilitaire de ligne de commande pour le traitement et la gestion de diverses tâches à l'aide d'un ensemble d'arguments et de configurations prédéfinis. Le projet vise à servir de référence pour développer des applications de ligne de commande similaires.

Il comprend des fonctionnalités telles que l'analyse des arguments, la gestion de la configuration et une structure modulaire pour faciliter le développement de code évolutif et maintenable.

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

• Template Python Project
• Template Package Importable

Caractéristiques

• Architecture modulaire : organiser votre code en modules pour une meilleure maintenabilité.
• Analyse de l'argument : gérer facilement les arguments en ligne de commande à l'aide argparse .
• Gestion de la configuration : générer des objets de configuration à partir des arguments de ligne de commande.
• Exceptions personnalisées : implémentez les exceptions personnalisées pour une gestion spécifique des erreurs.

Installation

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

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

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

Usage

Pour exécuter le package CLI, exécutez la fonction main du script principal:

python -m wolfsoftware.template_package_cli.main --required < value >

Arguments en ligne de commande

L'application prend en charge plusieurs arguments en ligne de commande:

• -h, --help : montrez le message d'aide et la sortie.
• -d, --debug : Activer le mode de débogage pour la sortie verbeux.
• -v, --verbose : permettez à la sortie verbale de montrer les résultats de numérisation au fur et à mesure qu'ils arrivent.
• -V, --version : affichez le numéro de version et la sortie du programme.
• -i, --optional-integer : un argument entier facultatif (par défaut: 2).
• -s, --optional-string : un argument de chaîne facultatif (par défaut: "moi").
• -r, --required : un argument de chaîne requis.

Exemple d'utilisation:

python -m wolfsoftware.template_package_cli.main -r " required_value " -i 10 -s " optional_string " 

Structure du projet

Le projet est organisé comme suit:

template-package-cli/
├── wolfsoftware/
│   └── template_package_cli/
│       ├── __init__.py
│       ├── cli.py
│       ├── config.py
│       ├── exceptions.py
│       ├── globals.py
│       └── main.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_cli : contient les modules de base de l'application.
  • cli.py : gère les arguments en ligne de commande et le flux principal du programme.
  • config.py : gère la création de configuration à partir des arguments de ligne de commande.
  • exceptions.py : gère les exceptions personnalisées.
  • globals.py : définit les constantes mondiales utilisées dans l'application.
  • main.py : le script principal qui orchestre l'analyse des arguments et l'exécution du programme.
• requirements.txt : répertorie les dépendances requises pour le projet.
• README.md : le fichier que vous lisez actuellement.