nexlipy

Documentation du framework Nexlipy

Nexlipy est un cadre modulaire conçu pour créer des services persistants sur des serveurs basés sur Linux. Il permet aux développeurs de configurer, de planifier et de gérer facilement divers modules qui peuvent s'exécuter indéfiniment ou en fonction des intervalles spécifiques. Le cadre fournit une structure flexible pour gérer plusieurs tâches de service, journalisation, appels API et comportements de service. Cette documentation décrit la structure de Nexlipy et fournit des directives sur la façon de créer des modules et des services à l'aide du cadre.

Caractéristiques clés:

• Architecture modulaire permettant la création et la gestion faciles des modules de service.
• Configuration basée sur YAML pour l'environnement, la planification et les paramètres d'API.
• Fonctionnalité de journalisation pour capturer les comportements et événements de service.
• Capacité à différencier les environnements de développement et de production.
• Capacités de planification pour les modules avec des intervalles d'exécution spécifiques.

Installez les dépendances requises

Toutes les dépendances sont répertoriées dans le fichier exigence.txt. Utilisez la commande suivante pour les installer:

pip install -r requirements.txt

Configuration

La configuration est gérée via un fichier YAML (service.yaml), qui se trouve dans le répertoire config /. Ce fichier définit les paramètres globaux de l'environnement de service, les connexions API, la journalisation et la planification.

Structure du projet

Le cadre Nexlipy suit une structure propre et organisée:

 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

Création de modules

Les modules de service sont définis dans les modules / répertoire. Chaque module doit résider dans son propre répertoire et inclure un fichier init .py où la logique de service est implémentée.

Notes

Veuillez garder à l'esprit que ce cadre a été entièrement créé en tant que projet personnel pour que mon serveur Linux puisse répondre aux besoins amateurs. Si vous souhaitez soutenir le projet, n'hésitez pas à signaler les problèmes ou les demandes de fonctionnalités dans la section des problèmes. Vous êtes invités à contribuer au projet de quelque manière que ce soit. Si vous souhaitez améliorer ou optimiser les parties du projet, n'hésitez pas à soumettre une demande de traction. Merci d'avance pour votre intérêt et votre soutien!