nexlipy

Dokumentasi Kerangka Kerja Nexlipy

NEXLIPY adalah kerangka kerja modular yang dirancang untuk menciptakan layanan persisten di server berbasis Linux. Ini memungkinkan pengembang untuk dengan mudah mengonfigurasi, menjadwalkan, dan mengelola berbagai modul yang dapat berjalan tanpa batas atau berdasarkan interval tertentu. Kerangka kerja ini menyediakan struktur yang fleksibel untuk menangani beberapa tugas layanan, penebangan, panggilan API, dan perilaku layanan. Dokumentasi ini menguraikan struktur NEXLIPY dan memberikan panduan tentang cara membangun modul dan layanan menggunakan kerangka kerja.

Fitur Utama:

• Arsitektur modular yang memungkinkan pembuatan dan pengelolaan modul layanan yang mudah.
• Konfigurasi berbasis YAML untuk lingkungan, penjadwalan, dan pengaturan API.
• Fungsi logging untuk menangkap perilaku dan acara layanan.
• Kemampuan untuk membedakan antara lingkungan pengembangan dan produksi.
• Kemampuan penjadwalan untuk modul dengan interval eksekusi tertentu.

Pasang dependensi yang diperlukan

Semua dependensi tercantum dalam file persyaratan.txt. Gunakan perintah berikut untuk menginstalnya:

pip install -r requirements.txt

Konfigurasi

Konfigurasi dikelola melalui file YAML (service.yaml), yang terletak di direktori/ direktori. File ini mendefinisikan pengaturan global untuk lingkungan layanan, koneksi API, penebangan, dan penjadwalan.

Struktur proyek

Kerangka kerja Nexlipy mengikuti struktur yang bersih dan terorganisir:

 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

Membuat modul

Modul layanan didefinisikan dalam modul/ direktori. Setiap modul harus berada di dalam direktori sendiri dan menyertakan file init .py di mana logika layanan diimplementasikan.

Catatan

Harap diingat bahwa kerangka kerja ini dibuat sepenuhnya sebagai proyek pribadi untuk server Linux saya untuk memenuhi kebutuhan amatir. Jika Anda ingin mendukung proyek, jangan ragu untuk melaporkan masalah atau permintaan fitur di bagian masalah. Anda dipersilakan untuk berkontribusi pada proyek dengan cara apa pun yang Anda suka. Jika Anda ingin meningkatkan atau mengoptimalkan bagian proyek apa pun, jangan ragu untuk mengirimkan permintaan tarik. Terima kasih sebelumnya atas minat dan dukungan Anda!