nexlipy

Nexlipy Framework -Dokumentation

NexLipy ist ein modulares Framework, das zum Erstellen anhaltender Dienste auf Linux-basierten Servern entwickelt wurde. Es ermöglicht den Entwicklern, verschiedene Module einfach zu konfigurieren, zu planen und zu verwalten, die auf bestimmte Intervalle auf unbestimmte Zeit oder basierend auf Basis von bestimmten Intervallen ausgeführt werden können. Das Framework bietet eine flexible Struktur für die Behandlung mehrerer Serviceaufgaben, Protokollierung, API -Anrufe und Serviceverhalten. Diese Dokumentation beschreibt die Struktur der Nexlipy und enthält Richtlinien zum Erstellen von Modulen und Diensten mithilfe des Frameworks.

Schlüsselmerkmale:

• Modulare Architektur ermöglicht eine einfache Erstellung und Verwaltung von Servicemodulen.
• YAML-basierte Konfiguration für Umgebungs-, Planungs- und API-Einstellungen.
• Protokollierungsfunktionalität zum Erfassen von Serviceverhalten und -ereignissen.
• Fähigkeit, zwischen Entwicklungs- und Produktionsumgebungen zu unterscheiden.
• Planungsfunktionen für Module mit spezifischen Ausführungsintervallen.

Installieren Sie die erforderlichen Abhängigkeiten

Alle Abhängigkeiten sind in der Datei "Anforderungen.txt" aufgeführt. Verwenden Sie den folgenden Befehl, um sie zu installieren:

pip install -r requirements.txt

Konfiguration

Die Konfiguration wird über eine YAML -Datei (service.yaml) verwaltet, die sich im Konfigurations-/ Verzeichnis befindet. Diese Datei definiert globale Einstellungen für die Serviceumgebung, API -Verbindungen, Protokollierung und Planung.

Projektstruktur

Das Nexlipy -Framework folgt einer sauberen und organisierten Struktur:

 nexlipy/
│
├── config/
│   └── __init__.py     # Loads configuration from service.yaml
│   └── service.yaml    # Configuration file for services, API, and logging
│
├── modules/            # Directory where service modules are stored
│   ├── __init__.py     # Loads and manages all modules
│   ├── Hello/          # Example module directory
│   │   └── __init__.py # Example service module
│
├── main.py             # Main script to start and run all services
└── README.md           # Project documentation

Module erstellen

Servicemodule sind in den Modulen/ Verzeichnissen definiert. Jedes Modul muss sich in seinem eigenen Verzeichnis befinden und eine init .py -Datei enthalten, in der die Dienstlogik implementiert wird.

Notizen

Bitte beachten Sie, dass dieses Framework vollständig als persönliches Projekt für meinen Linux -Server erstellt wurde, um die Amateuranforderungen zu erfüllen. Wenn Sie das Projekt unterstützen möchten, können Sie Probleme oder Feature -Anfragen im Abschnitt "Ausgaben" melden. Sie können gerne auf eine Weise zum Projekt beitragen, die Sie möchten. Wenn Sie Teile des Projekts verbessern oder optimieren möchten, können Sie eine Pull -Anfrage vorlegen. Vielen Dank im Voraus für Ihr Interesse und Ihre Unterstützung!