Unduh GitHubSentinel - Unduh Kode Sumber GitHubSentinel

GitHubSentinel

Kode sumber lainnya

v0.8.2

Unduh

Sentinel GitHub

Bahasa Inggris |

Daftar isi

Sentinel GitHub
Fungsi utama
Tangkapan layar produk
Mulailah dengan cepat
- 1. Ketergantungan Instalasi
- 2. Konfigurasikan Aplikasi
- 3. Cara Berlari
  - A. Jalankan sebagai alat baris perintah
  - B. Jalankan sebagai layanan latar belakang
  - C. Jalankan sebagai server gradio
Instalasi dan rilis layanan Ollama
Pengujian unit
- Pengujian unit dan skrip validasi validate_tests.sh
  - menggunakan
  - Fungsi
Bangun dan verifikasi dengan Docker
- 1. Dockerfile
  - menggunakan
  - Langkah -langkah kunci
- 2. build_image.sh
  - menggunakan
  - Fungsi
menyumbang
lisensi
menghubungkan

Github Sentinel adalah AI Agent yang dirancang untuk pengambilan informasi cerdas dan penambangan konten bernilai tinggi yang dirancang khusus untuk era model besar (LLMS). Ini ditujukan untuk pengguna yang membutuhkan frekuensi tinggi dan sejumlah besar akuisisi informasi, terutama penggemar open source, pengembang individu dan investor.

Fungsi utama

Manajemen Langganan : Dengan mudah mengelola dan melacak repositori GitHub yang Anda ikuti.
Pembaruan Pengambilan : Secara otomatis mengambil dan merangkum pembaruan terbaru dari repositori berlangganan, termasuk catatan pengiriman, pertanyaan, dan permintaan tarik.
Sistem Pemberitahuan : Beri tahu pelanggan tentang kemajuan terbaru proyek secara real time melalui email dan cara lainnya.
Generasi Laporan : Menghasilkan laporan kemajuan proyek terperinci berdasarkan pembaruan yang diambil, mendukung banyak format dan templat untuk memenuhi kebutuhan yang berbeda.
Dukungan Multi-Model : Menggabungkan model OpenAI dan Ollama, laporan proyek bahasa alami dihasilkan untuk menyediakan layanan informasi yang lebih cerdas dan lebih akurat.
Tugas Pengaturan Waktu : Mendukung pelaksanaan tugas waktu dengan cara daemon untuk memastikan akses tepat waktu ke pembaruan informasi.
Antarmuka grafis : Berdasarkan gradio, ia menyadari mode operasi GUI yang sederhana dan mudah digunakan, menurunkan ambang batas untuk digunakan.
Kontainerisasi : Proyek ini mendukung konstruksi Docker dan penyebaran kemauan, yang memfasilitasi penyebaran dan operasi yang cepat di lingkungan yang berbeda.
Integrasi Berkelanjutan : Pengujian unit lengkap diimplementasikan untuk memfasilitasi konfigurasi lebih lanjut dari proses CI/CD tingkat produksi untuk memastikan stabilitas proyek dan pengiriman berkualitas tinggi.

Github Sentinel tidak hanya membantu pengguna secara otomatis melacak dan menganalisis pembaruan terbaru dari GitHub 开源项目, tetapi juga dengan cepat berkembang ke saluran informasi lain, seperti topik populer Hacker News , menyediakan kemampuan penambangan informasi dan analisis yang lebih komprehensif.

Tangkapan layar produk

Pelacakan dan Ringkasan Kemajuan Proyek GitHub

gradio_v0.8_github

Berita Hacker Topik Topik Teknik Panas gradio_v0.8_hn

Mulailah dengan cepat

1. Ketergantungan Instalasi

Pertama, instal dependensi yang diperlukan:

pip install -r requirements.txt

2. Konfigurasikan Aplikasi

Edit file config.json untuk mengatur token github Anda, pengaturan email (mengambil tencent wechat mailbox sebagai contoh), file berlangganan, perbarui pengaturan, konfigurasi layanan model besar (mendukung OpenAI GPT API dan Ollama Private Big Model Service) secara otomatis mengambil dan menghasilkan Laporan (GITHUB Kemajuan Proyek, Hacker News Topics dan Topik Topik-Topik Topik-Jalur-tepi Topik Ujung Manding

{
    "github" : {
        "token" : " your_github_token " ,
        "subscriptions_file" : " subscriptions.json " ,
        "progress_frequency_days" : 1 ,
        "progress_execution_time" : " 08:00 "
    },
    "email" :  {
        "smtp_server" : " smtp.exmail.qq.com " ,
        "smtp_port" : 465 ,
        "from" : " [email protected] " ,
        "password" : " your_email_password " ,
        "to" : " [email protected] "
    },
    "llm" : {
        "model_type" : " ollama " ,
        "openai_model_name" : " gpt-4o-mini " ,
        "ollama_model_name" : " llama3 " ,
        "ollama_api_url" : " http://localhost:11434/api/chat "
    },
    "report_types" : [
        " github " ,
        " hacker_news_hours_topic " ,
        " hacker_news_daily_report "
    ],
    "slack" : {
        "webhook_url" : " your_slack_webhook_url "
    }
}

Untuk alasan keamanan: baik token github dan pengaturan kata sandi email konfigurasi mendukung variabel lingkungan untuk menghindari konfigurasi informasi penting secara eksplisit, seperti yang ditunjukkan di bawah ini:

 # Github
export GITHUB_TOKEN= " github_pat_xxx "
# Email
export EMAIL_PASSWORD= " password "

3. Cara Berlari

Github Sentinel mendukung tiga cara berlari berikut:

A. Jalankan sebagai alat baris perintah

Anda dapat menjalankan aplikasi secara interaktif dari baris perintah:

python src/command_tool.py

Dalam mode ini, Anda dapat secara manual memasukkan perintah untuk mengelola langganan, mengambil pembaruan, dan menghasilkan laporan.

B. Jalankan sebagai layanan latar belakang

Untuk menjalankan aplikasi sebagai layanan latar belakang (Daemon), itu akan diperbarui secara otomatis berdasarkan konfigurasi yang relevan.

Anda dapat memulai, status kueri, menutup dan restart langsung menggunakan skrip manajemen daemon daemon_control.sh:

Mulai Layanan:
```
$ ./daemon_control.sh start
Starting DaemonProcess...
DaemonProcess started.
```
- Ini akan dimulai [./src/daemon_process.py], menghasilkan laporan secara teratur sesuai dengan frekuensi pembaruan dan titik waktu yang ditetapkan dalam config.json , dan mengirim email.
- Log layanan ini akan disimpan ke file logs/DaemonProcess.log . Pada saat yang sama, log kumulatif historis juga akan ditambahkan secara sinkron ke file log logs/app.log .

Status Layanan Permintaan:

$ ./daemon_control.sh status
DaemonProcess is running.

Tutup layanan:

$ ./daemon_control.sh stop
Stopping DaemonProcess...
DaemonProcess stopped.

Restart Layanan:

$ ./daemon_control.sh restart
Stopping DaemonProcess...
DaemonProcess stopped.
Starting DaemonProcess...
DaemonProcess started.

C. Jalankan sebagai server gradio

Untuk menjalankan aplikasi menggunakan antarmuka gradio, memungkinkan pengguna untuk berinteraksi dengan alat melalui antarmuka web:

python src/gradio_server.py

Ini akan memulai server web di mesin Anda, memungkinkan Anda untuk mengelola langganan dan menghasilkan laporan melalui antarmuka yang ramah pengguna.
Secara default, server gradio akan dapat diakses di http://localhost:7860 , tetapi Anda dapat membagikannya secara publik jika Anda mau.

Instalasi dan rilis layanan Ollama

Ollama adalah alat manajemen model besar swasta yang mendukung penyebaran lokal dan kemah, interaksi baris perintah, dan panggilan API REST.

Untuk instruksi terperinci tentang pelepasan layanan mockup penyebaran dan privatisasi ollama, silakan merujuk pada rilis penyebaran dan layanan instalasi Ollama.

Instalasi resmi singkat Ollama

Untuk menghubungi layanan mockup pribadi menggunakan Ollama di Github Sentinel, ikuti langkah -langkah ini untuk menginstal dan mengonfigurasi:

Instal Ollama : Silakan unduh dan instal Layanan Ollama sesuai dengan dokumentasi resmi Ollama. Ollama mendukung berbagai sistem operasi, termasuk Linux, Windows, dan MacOS.
Mulai Layanan Ollama : Setelah instalasi selesai, mulailah layanan Ollama dengan perintah berikut:
```
ollama serve
```
Secara default, API Ollama akan berjalan di http://localhost:11434 .

Mengkonfigurasi Penggunaan Ollama di Github Sentinel : Di file config.json , konfigurasikan informasi terkait API Ollama:

{
    "llm" : {
        "model_type" : " ollama " ,
        "ollama_model_name" : " llama3 " ,
        "ollama_api_url" : " http://localhost:11434/api/chat "
    }
}

Verifikasi konfigurasi : Mulai GitHub Sentinel dengan perintah berikut dan buat laporan untuk memverifikasi bahwa konfigurasi ollama benar:
```
python src/command_tool.py
```
Jika dikonfigurasi dengan benar, Anda akan dapat menghasilkan laporan melalui model Ollama.

Pengujian unit

Untuk memastikan kualitas dan keandalan kode, GitHub Sentinel menggunakan modul unittest untuk pengujian unit. Untuk deskripsi terperinci tentang unittest dan alat -alat terkait seperti @patch dan MagicMock , silakan merujuk ke detail tes unit.

Pengujian unit dan skrip validasi `validate_tests.sh`

menggunakan

validate_tests.sh adalah skrip shell yang menjalankan tes unit dan memvalidasi hasilnya. Ini dieksekusi selama proses pembangunan gambar Docker untuk memastikan kebenaran dan stabilitas kode.

Fungsi

Script menjalankan semua tes unit dan mengeluarkan hasilnya ke file test_results.txt .
Jika tes gagal, skrip mengeluarkan hasil tes dan menyebabkan Docker dibangun gagal.
Jika semua tes lulus, skrip terus membangun proses.

Bangun dan verifikasi dengan Docker

Untuk memfasilitasi konstruksi dan penyebaran proyek -proyek Sentinel GitHub di berbagai lingkungan, kami memberikan dukungan Docker. Dukungan ini mencakup file dan fitur berikut:

1. `Dockerfile`

menggunakan

Dockerfile adalah file konfigurasi yang digunakan untuk menentukan cara membangun gambar Docker. Ini menjelaskan langkah -langkah untuk membangun gambar, termasuk menginstal dependensi, menyalin file proyek, menjalankan tes unit, dll.

Langkah -langkah kunci

Gunakan python:3.10-slim sebagai gambar dasar dan atur direktori kerja ke /app .
Salin file requirements.txt proyek dan instal dependensi Python.
Salin semua file proyek ke wadah dan berikan izin eksekusi skrip validate_tests.sh .
Jalankan skrip validate_tests.sh selama proses pembangunan untuk memastikan bahwa semua tes unit lulus. Jika tes gagal, proses pembangunan akan dibatalkan.
Setelah build berhasil, src/main.py akan dijalankan secara default sebagai titik masuk wadah.

2. `build_image.sh`

menggunakan

build_image.sh adalah skrip shell untuk secara otomatis membangun gambar Docker. Dibutuhkan nama cabang dari cabang Git saat ini dan menggunakannya sebagai label untuk gambar Docker, membuatnya lebih mudah untuk menghasilkan gambar Docker yang berbeda di cabang yang berbeda.

Fungsi

Mendapat nama cabang Git saat ini dan menggunakannya sebagai label untuk gambar Docker.
Gunakan perintah docker build untuk membangun gambar Docker dan gunakan nama cabang Git saat ini sebagai label.

Contoh penggunaan

chmod +x build_image.sh
./build_image.sh

build_docker_image

Melalui skrip ini dan file konfigurasi, dipastikan bahwa di berbagai cabang pengembangan, gambar Docker yang dibangun didasarkan pada kode yang telah diuji unit, sehingga meningkatkan kualitas kode dan keandalan penyebaran.

menyumbang

Kontribusi adalah apa yang membuat komunitas open source luar biasa untuk dipelajari, menginspirasi, dan menciptakan. Terima kasih banyak atas kontribusi yang telah Anda buat. Jika Anda memiliki saran atau permintaan fitur, silakan mulai topik untuk membahas apa yang ingin Anda ubah.