nexlipy

Documentação da estrutura nexlipy

O Nexlipy é uma estrutura modular projetada para criar serviços persistentes em servidores baseados em Linux. Ele permite que os desenvolvedores configurem, agende e gerenciem facilmente vários módulos que podem ser executados indefinidamente ou com base em intervalos específicos. A estrutura fornece uma estrutura flexível para lidar com várias tarefas de serviço, registro, chamadas de API e comportamentos de serviço. Esta documentação descreve a estrutura do Nexlipy e fornece diretrizes sobre como criar módulos e serviços usando a estrutura.

Principais recursos:

• Arquitetura modular, permitindo uma fácil criação e gerenciamento de módulos de serviço.
• Configuração baseada em YAML para configurações de ambiente, programação e API.
• Funcionalidade de registro para capturar comportamentos e eventos de serviço.
• Capacidade de diferenciar os ambientes de desenvolvimento e produção.
• Recursos de agendamento para módulos com intervalos de execução específicos.

Instale as dependências necessárias

Todas as dependências estão listadas no arquivo requisitos.txt. Use o seguinte comando para instalá -los:

pip install -r requirements.txt

Configuração

A configuração é gerenciada por meio de um arquivo YAML (Service.yaml), localizado na configuração/ diretório. Este arquivo define configurações globais para o ambiente de serviço, conexões de API, log e agendamento.

Estrutura do projeto

A estrutura Nexlipy segue uma estrutura limpa e 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

Criando módulos

Os módulos de serviço são definidos nos módulos/ diretórios. Cada módulo deve residir em seu próprio diretório e incluir um arquivo .py initing , onde a lógica de serviço é implementada.

Notas

Lembre -se de que essa estrutura foi criada inteiramente como um projeto pessoal para o meu servidor Linux para atender às necessidades amadoras. Se você deseja apoiar o projeto, sinta -se à vontade para relatar questões ou solicitações de recursos na seção de problemas. Você pode contribuir com o projeto da maneira que quiser. Se você deseja melhorar ou otimizar qualquer parte do projeto, sinta -se à vontade para enviar uma solicitação de tração. Agradecemos antecipadamente por seu interesse e apoio!