Главная страница>Связанные с программированием>Другой исходный код
Скачать

Github Sentinel


Английский |

Оглавление

  • Github Sentinel
  • Основные функции
  • Скриншот продукта
  • Начните быстро
    • 1. Зависимости установки
    • 2. Настройте приложение
    • 3. Как бежать
      • A. Запустить в качестве инструмента командной строки
      • B. Беги как фоновая служба
      • C. Запустить как сервер Gradio
  • Установка и выпуск услуг Ollama
  • ЕДИНЦИОННЫЕ Тестирование
    • Модульное тестирование и проверка скрипта validate_tests.sh
      • использовать
      • Функция
  • Создать и проверить с помощью Docker
    • 1. Dockerfile
      • использовать
      • Ключевые шаги
    • 2. build_image.sh
      • использовать
      • Функция
  • способствовать
  • лицензия
  • соединять

Github Sentinel-это AI Agent предназначенный для интеллектуального поиска информации и добычи высокого содержания, специально разработанного для эпохи больших моделей (LLMS). Он предназначен для пользователей, которые нуждаются в высокой частоте и больших объемах получения информации, особенно энтузиастов с открытым исходным кодом, отдельных разработчиков и инвесторов.

Основные функции

  • Управление подпиской : легко управлять и отслеживать репозиторий GitHub, которым вы следуете.
  • Обновление поиска : автоматически извлечь и суммируйте последние обновления репозиториев подписки, включая записи отправки, вопросы и запросы на вывод.
  • Система уведомлений : уведомление подписчиков о последнем прогрессе проекта в режиме реального времени с помощью электронных писем и других средств.
  • Генерация отчетов : генерируйте подробные отчеты о прогрессе проекта на основе полученных обновлений, поддержки нескольких форматов и шаблонов для удовлетворения различных потребностей.
  • Поддержка с несколькими моделями : объединение моделей OpenAI и Ollama, отчеты о проектах естественного языка создаются для предоставления более умных и более точных информационных услуг.
  • Задачи времени : поддерживает выполнение задач по времени в демоне, чтобы обеспечить своевременный доступ к обновлениям информации.
  • Графический интерфейс : на основе Gradio, он реализует простой и простой в использовании режим работы с графическим интерфейсом, снижая порог для использования.
  • Контейнеризация : проект поддерживает конструкцию Docker и развертывание контейнеров, которое облегчает быстрое развертывание и эксплуатацию в разных средах.
  • Непрерывная интеграция : полное модульное тестирование реализовано для облегчения дальнейшей конфигурации процессов CI/CD на уровне производства для обеспечения стабильности проекта и высококачественной доставки.

GitHub Sentinel не только помогает пользователям автоматически отслеживать и анализировать последние обновления GitHub 开源项目, но и быстро расширяться на другие информационные каналы, такие как популярные темы Hacker News , предоставляя более полную информацию для анализа информации и анализа.

Скриншот продукта

Отслеживание прогресса в проекте GitHub

gradio_v0.8_github

Hacker News Hot Tech Mining gradio_v0.8_hn

Начните быстро

1. Зависимости установки

Во -первых, установите требуемые зависимости: 

pip install -r requirements.txt

2. Настройте приложение

Отредактируйте файл config.json , чтобы установить токен GitHub, настройки электронной почты (пример Tencent WeChat в качестве примера), файлы подписки, настройки обновления, конфигурация услуг Big Model (поддерживает API OpenAI GPT и Ollama Private Big Model Service), а также автоматически получение и создание отчетов (Github Project, Hacker News Hot Topics и современные тренды технологий): 

{
    "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 "
    }
}

По соображениям безопасности: как токен Github, так и настройки пароля электронной почты. Настройки поддержки с использованием переменных среды, чтобы избежать явной настройки важной информации, как показано ниже: 

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

3. Как бежать

GitHub Sentinel поддерживает следующие три способа работы:

A. Запустить в качестве инструмента командной строки

Вы можете запустить приложение интерактивно из командной строки: 

python src/command_tool.py

В этом режиме вы можете вручную вводить команды для управления подписками, получения обновлений и генерации отчетов.

B. Беги как фоновая служба

Чтобы запустить приложение в качестве фоновой службы (Daemon), оно будет обновляться автоматически на основе соответствующей конфигурации.

Вы можете начать, статус запроса, закрыть и перезагрузить непосредственно с помощью сценария управления демонами daemon_control.sh:

  1. Начните сервис: 

    $ ./daemon_control.sh start
Starting DaemonProcess...
DaemonProcess started.
    • Это начнется [./src/daemon_process.py], регулярно генерирует отчеты в соответствии с частотой обновления и моментами времени, установленными в config.json , и отправлять электронные письма.
    • Этот журнал услуг будет сохранен в файле logs/DaemonProcess.log . В то же время исторические кумулятивные журналы также будут синхронно добавлены в файл журнала logs/app.log .

  2. Статус обслуживания запросов: 

    $ ./daemon_control.sh status
DaemonProcess is running.

  3. Закройте сервис: 

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

  4. Перезагрузите услугу: 

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

C. Запустить как сервер Gradio

Чтобы запустить приложение, используя интерфейс Gradio, позвольте пользователям взаимодействовать с инструментом через веб -интерфейс: 

python src/gradio_server.py
  • Это запустит веб-сервер на вашей машине, позволяя вам управлять подписку и генерировать отчеты через удобный интерфейс.
  • По умолчанию сервер Gradio будет доступен по адресу http://localhost:7860 , но вы можете поделиться им публично, если хотите.

Установка и выпуск услуг Ollama

Ollama-это частный инструмент управления крупным моделью, который поддерживает локальное и контейнерное развертывание, взаимодействие командной строки и вызовы API REST.

Для получения подробных инструкций по выпуску службы развертывания и приватизации Ollama Mockup, пожалуйста, см.

Краткая официальная инсталляция Ollama

Чтобы позвонить в частную службу макета, используя Ollama в GitHub Sentinel, выполните эти шаги для установки и настройки:

  1. Установите Ollama : Пожалуйста, загрузите и установите сервис Ollama в соответствии с официальной документацией Ollama. Ollama поддерживает различные операционные системы, включая Linux, Windows и MacOS.

  2. Запустите службу Ollama : после завершения установки запустите службу Ollama со следующей командой: 

    ollama serve

    По умолчанию API Ollama будет работать по http://localhost:11434 .

  3. Настройка использования OLLAMA в GitHub Sentinel : в файле config.json настройте информацию, связанную с API Ollama: 

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

  4. Проверьте конфигурацию : запустите GitHub Sentinel со следующей командой и создайте отчет, чтобы убедиться, что конфигурация Ollama верна: 

    python src/command_tool.py

    Если вы настроите правильно, вы сможете генерировать отчеты через модель Ollama.

ЕДИНЦИОННЫЕ Тестирование

Чтобы обеспечить качество и надежность кода, Github Sentinel использует модуль unittest для модульного тестирования. Для получения подробных описаний unittest и связанных с ним инструментов, таких как @patch и MagicMock , пожалуйста, обратитесь к деталям теста модуля.

Модульное тестирование и проверка скрипта validate_tests.sh

использовать

validate_tests.sh - это скрипт оболочки, который запускает модульные тесты и проверяет результаты. Он выполняется во время процесса построения изображений Docker, чтобы обеспечить правильность и стабильность кода.

Функция

  • Сценарий запускает все модульные тесты и выводит результаты в файл test_results.txt .
  • Если тест не удается, сценарий выводит результаты теста и приводит к сбои сборки Docker.
  • Если все тесты проходят, сценарий продолжает создавать процесс.

Создать и проверить с помощью Docker

Чтобы облегчить строительство и развертывание проектов GitHub Sentinel в различных условиях, мы предоставляем поддержку Docker. Эта поддержка включает в себя следующие файлы и функции:

1. Dockerfile

использовать

Dockerfile - это файл конфигурации, используемый для определения того, как создать изображение Docker. Он описывает шаги по созданию изображения, включая установку зависимостей, копирование файлов проекта, выполнения модульных тестов и т. Д.

Ключевые шаги

  • Используйте python:3.10-slim в качестве базового изображения и установите рабочий каталог в /app .
  • Скопируйте файл requirements.txt проекта.
  • Скопируйте все файлы проекта в контейнер и дайте разрешение на выполнение скрипта validate_tests.sh .
  • Выполните скрипт validate_tests.sh во время процесса сборки, чтобы убедиться, что все модульные тесты пройдут. Если тест не удается, процесс сборки будет прерван.
  • После того, как сборка будет успешной, src/main.py будет работать по умолчанию в качестве точки входа контейнера.

2. build_image.sh

использовать

build_image.sh - это сценарий оболочки для автоматического создания изображений Docker. Он берет имя ветви из текущей ветви GIT и использует его в качестве метки для изображения Docker, что облегчает генерацию разных изображений докеров на разных ветвях.

Функция

  • Получает текущее имя ветви GIT и использует его в качестве метки для изображения Docker.
  • Используйте команду docker build , чтобы построить изображение Docker и использовать текущее имя ветви GIT в качестве метки.

Пример использования 

chmod +x build_image.sh
./build_image.sh

build_docker_image

Благодаря этим сценариям и файлам конфигурации гарантируется, что в различных ветвях разработки настроенные изображения Docker основаны на протестировании на единицу кода, тем самым улучшая качество кода и надежность развертывания.

способствовать

Вклад - это то, что делает сообщество с открытым исходным кодом для изучения, вдохновления и создания. Большое спасибо за любой вклад, который вы внесли. Если у вас есть какие -либо предложения или запросы на функции, пожалуйста, запустите тему, чтобы обсудить, что вы хотите изменить.

лицензия

Проект лицензирован в соответствии с условиями лицензии Apache-2.0. Смотрите файл лицензии для получения подробной информации.

соединять

Django peng - [email protected]

Ссылка проекта: https://github.com/djangopeng/githubsentinel

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все