template package importable

Überblick

Dies ist die Paketvorlage, die wir intern verwenden, um neue Python -basierte importierbare Pakete 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.

Diese Paketvorlage bietet keine CLI -Funktionalität, sondern ist für die Erstellung von importierbaren Paketen konzipiert.

Wir haben uns entschlossen, dies zusammen mit unseren anderen Tools zur Verfügung zu stellen, damit die Menschen beim Erstellen ihrer eigenen Werkzeuge einen gut konstruierten Startpunkt verwenden können.

Wir bieten auch 2 andere Vorlagen, die wir verwenden.

• Vorlage Python -Projekt
• Vorlagepaket CLI

Merkmale

• Modulare Architektur : organisieren Sie Ihren Code in Module, um eine bessere Wartbarkeit zu erhalten.
• Benutzerdefinierte Ausnahmen : Grundlegende Beispiele für die Implementierung benutzerdefinierter Ausnahmen für die spezifische Fehlerbehandlung.
• Testbeispiele : Grundlegende Beispiele für das Schreiben von PyTest -Tests für Ihr Paket.

Installation

Klonen Sie das Repository, um das importierbare Paket zu installieren, das Repository und navigieren Sie zum Projektverzeichnis:

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

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

Projektstruktur

Das Projekt ist wie folgt organisiert:

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 : Enthält die Kernmodule der Anwendung.
  • exceptions.py : Verarbeitet benutzerdefinierte Ausnahmen.
  • functions.py : Definiert einige Beispielfunktionen (zum Testen).
• tests : Wo sich die PyTest -Tests befinden.
  • test_template_package_importable.py : Die zu ausgeführten spezifischen Tests.
• setup.py : Die Paketkonfiguration.
• requirements.txt : Listet die für das Projekt erforderlichen Abhängigkeiten auf.
• README.md : Die Datei, die Sie gerade lesen.