template package cli

Überblick

Dies ist die Paketvorlage, die wir intern verwenden, um neue Python -CLI -basierte Tools zu erstellen. Es verfügt über alle grundlegenden Funktionen und Workflows, die zum Erstellen, Erstellen und Veröffentlichen eines neuen Pakets für PYPI erforderlich sind.

Dieses Paket bietet ein Befehlszeilendienstprogramm für die Verarbeitung und Handhabung verschiedener Aufgaben mithilfe einer Reihe vordefinierter Argumente und Konfigurationen. Das Projekt zielt darauf ab, als Grundlinie für die Entwicklung ähnlicher Befehlszeilenanwendungen zu dienen.

Es enthält Funktionen wie Argument -Parsen, Konfigurationsmanagement und eine modulare Struktur, um die skalierbare und wartbare Codentwicklung zu erleichtern.

Wir bieten auch 2 andere Vorlagen, die wir verwenden.

• Vorlage Python -Projekt
• Vorlagepaket importierbar

Merkmale

• Modulare Architektur : organisieren Sie Ihren Code in Module, um eine bessere Wartbarkeit zu erhalten.
• Argument-Parsing : Mit argparse leicht umgehen.
• Konfigurationsverwaltung : Generieren Sie Konfigurationsobjekte aus Befehlszeilenargumenten.
• Benutzerdefinierte Ausnahmen : Implementieren Sie benutzerdefinierte Ausnahmen für die spezifische Fehlerbehandlung.

Installation

Klonen Sie zum Installieren des CLI -Pakets das Repository und navigieren Sie zum Projektverzeichnis:

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

Es wird empfohlen, eine virtuelle Umgebung zu verwenden, um Abhängigkeiten zu verwalten. Sie können eine virtuelle Umgebung mit den folgenden Befehlen erstellen und aktivieren:

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

Installieren Sie die erforderlichen Abhängigkeiten:

pip install -r requirements.txt

Verwendung

Führen Sie die main aus dem Hauptskript aus, um das CLI -Paket auszuführen:

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

Befehlszeilenargumente

Die Anwendung unterstützt mehrere Befehlszeilenargumente:

• -h, --help : Hilfsnachricht anzeigen und beenden.
• -d, --debug : Aktivieren Sie den Debug -Modus für die ausführliche Ausgabe.
• -v, --verbose : Aktivieren Sie die ausführliche Ausgabe, um die Scan -Ergebnisse anzuzeigen, wenn sie hereinkommen.
• -V, --version : Zeigen Sie die Versionsnummer des Programms und beenden Sie.
• -i, --optional-integer : Ein optionales Ganzzahlargument (Standard: 2).
• -s, --optional-string : Ein optionales String-Argument (Standard: "Ich").
• -r, --required : Ein erforderliches String -Argument.

Beispiel Verwendung:

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

Projektstruktur

Das Projekt ist wie folgt organisiert:

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 : Enthält die Kernmodule der Anwendung.
  • cli.py : Verwendet die Befehlszeilenargumente und das Hauptprogrammfluss.
  • config.py : Verarbeitet die Konfigurationserstellung aus Befehlszeilenargumenten.
  • exceptions.py : Verarbeitet benutzerdefinierte Ausnahmen.
  • globals.py : Definiert globale Konstanten, die in der Anwendung verwendet werden.
  • main.py : Das Hauptskript, das Argument -Parsing und Programmausführung orchestriert.
• requirements.txt : Listet die für das Projekt erforderlichen Abhängigkeiten auf.
• README.md : Die Datei, die Sie gerade lesen.