nexlipy

Nexlipyフレームワークのドキュメント

Nexlipyは、Linuxベースのサーバーで永続的なサービスを作成するために設計されたモジュラーフレームワークです。これにより、開発者は無期限にまたは特定の間隔に基づいて実行できるさまざまなモジュールを簡単に構成、スケジュール、および管理できます。このフレームワークは、複数のサービスタスク、ロギング、API呼び出し、およびサービス行動を処理するための柔軟な構造を提供します。このドキュメントでは、Nexlipyの構造の概要を説明し、フレームワークを使用してモジュールとサービスを構築する方法に関するガイドラインを提供します。

主な機能：

• サービスモジュールの作成と管理を簡単に作成できるモジュラーアーキテクチャ。
• 環境、スケジューリング、およびAPI設定用のYAMLベースの構成。
• ロギング機能は、サービスの動作とイベントをキャプチャします。
• 開発環境と生産環境を区別する能力。
• 特定の実行間隔を持つモジュールのスケジューリング機能。

必要な依存関係をインストールします

すべての依存関係は、recumation.txtファイルにリストされています。次のコマンドを使用してそれらをインストールします。

pip install -r requirements.txt

構成

構成は、構成/ディレクトリにあるYAMLファイル（service.yaml）を介して管理されます。このファイルは、サービス環境、API接続、ロギング、スケジューリングのグローバル設定を定義します。

プロジェクト構造

Nexlipyフレームワークは、清潔で組織化された構造に従います。

 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

モジュールの作成

サービスモジュールは、モジュール/ディレクトリ内で定義されています。各モジュールは独自のディレクトリ内に存在し、サービスロジックが実装されているinit.pyファイルを含める必要があります。

メモ

このフレームワークは、Amateurのニーズを満たすためのLinuxサーバーの個人的なプロジェクトとして完全に作成されたことに留意してください。プロジェクトをサポートしたい場合は、問題や機能のリクエストを問題に報告してください。あなたが好きな方法でプロジェクトに貢献することを歓迎します。プロジェクトの部分を改善または最適化したい場合は、Pullリクエストをお気軽に送信してください。あなたの興味とサポートによろしくお願いします！