nexlipy

Documentación del marco de Nexlipy

Nexlipy es un marco modular diseñado para crear servicios persistentes en servidores basados ​​en Linux. Permite a los desarrolladores configurar, programar y administrar fácilmente varios módulos que pueden ejecutarse indefinidamente o basarse en intervalos específicos. El marco proporciona una estructura flexible para manejar múltiples tareas de servicio, registro, llamadas de API y comportamientos de servicio. Esta documentación describe la estructura de Nexlipy y proporciona pautas sobre cómo construir módulos y servicios utilizando el marco.

Características clave:

• Arquitectura modular que permite una fácil creación y gestión de módulos de servicio.
• Configuración basada en YAML para entorno, programación y configuraciones de API.
• Funcionalidad de registro para capturar comportamientos y eventos de servicio.
• Capacidad para diferenciar entre entornos de desarrollo y producción.
• Capacidades de programación para módulos con intervalos de ejecución específicos.

Instale las dependencias requeridas

Todas las dependencias se enumeran en el archivo requisitos.txt. Use el siguiente comando para instalarlos:

pip install -r requirements.txt

Configuración

La configuración se administra a través de un archivo YAML (Service.yaml), que se encuentra en el directorio config/. Este archivo define la configuración global para el entorno de servicio, las conexiones API, la registro y la programación.

Estructura de proyectos

El marco de Nexlipy sigue una estructura limpia y organizada:

 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

Creación de módulos

Los módulos de servicio se definen dentro de los módulos/ directorio. Cada módulo debe residir dentro de su propio directorio e incluir un archivo init .py donde se implementa la lógica del servicio.

Notas

Tenga en cuenta que este marco se creó completamente como un proyecto personal para que mi servidor Linux satisfaga las necesidades de aficionados. Si desea apoyar el proyecto, no dude en informar problemas o solicitudes de funciones en la sección de problemas. Puede contribuir al proyecto de cualquier manera que desee. Si desea mejorar u optimizar cualquier parte del proyecto, no dude en enviar una solicitud de extracción. ¡Gracias de antemano por su interés y apoyo!