Download do GitHubSentinel - GitHubSentinel Download do código -fonte

GitHubSentinel

Outro código-fonte

v0.8.2

Baixar

Github Sentinel

Inglês |

Índice

Github Sentinel
Funções principais
Captura de tela de produtos
Comece rapidamente
- 1. Dependências de instalação
- 2. Configure o aplicativo
- 3. Como correr
  - A. Corra como uma ferramenta de linha de comando
  - B. Corra como um serviço de segundo plano
  - C. Corra como um servidor graduado
Ollama Instalação e liberação de serviço
Teste de unidade
- Script de teste e validação de unidade validate_tests.sh
  - usar
  - Função
Construa e verifique com o Docker
- 1. Dockerfile
  - usar
  - Etapas -chave
- 2. build_image.sh
  - usar
  - Função
contribuir
licença
conectar

O Github Sentinel é AI Agent projetado para recuperação de informações inteligentes e mineração de conteúdo de alto valor especialmente projetada para a era dos grandes modelos (LLMS). Visa que os usuários que precisam de alta frequência e grandes quantidades de aquisição de informações, especialmente entusiastas de código aberto, desenvolvedores e investidores individuais.

Funções principais

Gerenciamento de assinatura : gerencie e rastreie facilmente o repositório do GitHub que você segue.
Recuperação de atualização : recupere e resuma automaticamente as atualizações mais recentes dos repositórios de assinatura, incluindo registros de envio, perguntas e solicitações de puxar.
Sistema de notificação : notifique os assinantes do mais recente progresso do projeto em tempo real por meio de e -mails e outros meios.
Geração de relatórios : gerar relatórios detalhados de progresso do projeto com base nas atualizações recuperadas, suportando vários formatos e modelos para atender às diferentes necessidades.
Suporte a vários modelos : combinando modelos OpenAi e Ollama, os relatórios de projetos de idiomas naturais são gerados para fornecer serviços de informação mais inteligentes e precisos.
Tarefas de tempo : suporta a execução de tarefas de tempo de maneira daemon para garantir atualizações e obtimentos de informações oportunas.
Interface gráfica : Baseada no Gradio, ele realiza um modo de operação GUI simples e fácil de usar, abaixando o limite para uso.
RECIMENTAÇÃO : O projeto suporta a construção do Docker e a implantação de contêineres, o que facilita a implantação e operação rápidas em diferentes ambientes.
Integração contínua : o teste completo de unidade é implementado para facilitar a configuração adicional dos processos de IC/CD no nível da produção para garantir a estabilidade do projeto e a entrega de alta qualidade.

O GitHub Sentinel não apenas ajuda os usuários a rastrear e analisar automaticamente as atualizações mais recentes dos GitHub 开源项目, mas também expandir rapidamente para outros canais de informação, como os tópicos populares das Hacker News , fornecendo recursos de mineração e análise de informações mais abrangentes.

Captura de tela de produtos

Rastreamento e resumo do progresso do projeto do GitHub

gradio_v0.8_github

Hacker News Hot Tech Tópico Mineração gradio_v0.8_hn

Comece rapidamente

1. Dependências de instalação

Primeiro, instale as dependências necessárias:

pip install -r requirements.txt

2. Configure o aplicativo

Edite o arquivo config.json para definir seu token github, configurações de e-mail (tomando a caixa de correio do tencent WeChat como exemplo), arquivos de assinatura, configurações de atualização, configuração de serviço de modelo Big Model (suporta o OpenAI GPT API e o serviço de modelo de modelo e geram relatórios do Github (Github, os tópicos de hacker notícias e os tópicos de hacker e o hacker e o bletward) e recuperam e geram relatórios do projeto, o projeto do projeto, os tópicos de hacker notícias e o hacker e o blet- swords e o bletwert e o githb, os relatórios do Github.

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

Por razões de segurança: Tanto o token do github quanto as configurações de senha de e -mail suportam a configuração usando variáveis de ambiente para evitar a configuração explícita de informações importantes, como mostrado abaixo:

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

3. Como correr

O Github Sentinel suporta as três maneiras a seguir de corrida:

A. Corra como uma ferramenta de linha de comando

Você pode executar o aplicativo interativamente a partir da linha de comando:

python src/command_tool.py

Nesse modo, você pode inserir manualmente os comandos para gerenciar assinaturas, recuperar atualizações e gerar relatórios.

B. Corra como um serviço de segundo plano

Para executar o aplicativo como um serviço em segundo plano (daemon), ele será atualizado automaticamente com base na configuração relevante.

Você pode iniciar o status de consulta, fechar e reiniciar diretamente usando o script de gerenciamento daemon daemon_control.sh:

Inicie o serviço:
```
$ ./daemon_control.sh start
Starting DaemonProcess...
DaemonProcess started.
```
- Isso iniciará [./src/daemon_process.py], gerará relatórios regularmente de acordo com a frequência de atualização e os pontos de tempo definidos no config.json e enviarão emails.
- Este log de serviço será salvo no arquivo logs/DaemonProcess.log . Ao mesmo tempo, os registros cumulativos históricos também serão de síncrona anexada ao arquivo de logs/app.log .

Status do serviço de consulta:

$ ./daemon_control.sh status
DaemonProcess is running.

Feche o serviço:

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

Reinicie o serviço:

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

C. Corra como um servidor graduado

Para executar um aplicativo usando a interface Gradio, permita que os usuários interajam com a ferramenta através da interface da Web:

python src/gradio_server.py

Isso iniciará um servidor da Web em sua máquina, permitindo gerenciar assinaturas e gerar relatórios por meio de uma interface amigável.
Por padrão, o Gradio Server estará acessível em http://localhost:7860 , mas você pode compartilhá -lo publicamente, se quiser.

Ollama Instalação e liberação de serviço

O Ollama é uma ferramenta privada de gerenciamento de modelo que suporta implantação local e contêiner, interação com linha de comando e chamadas de API REST.

Para obter instruções detalhadas sobre o lançamento do Serviço de Mockup de implantação e privatização de instalação do Ollama, consulte a liberação da implantação e serviço de instalação do Ollama.

Ollama breve instalação oficial

Para ligar para o serviço de maquete privado usando o Ollama no Github Sentinel, siga estas etapas para instalar e configurar:

Instale o ollama : faça o download e instale o serviço Ollama, de acordo com a documentação oficial de Ollama. A Ollama suporta uma variedade de sistemas operacionais, incluindo Linux, Windows e MacOS.
Inicie o serviço Ollama : Após a conclusão da instalação, inicie o serviço Ollama com o seguinte comando:
```
ollama serve
```
Por padrão, a API Ollama será executada em http://localhost:11434 .

Configurando o uso de Ollama no Github Sentinel : no arquivo config.json , configure as informações relacionadas à API da Ollama:

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

Verifique a configuração : Inicie o Github Sentinel com o seguinte comando e gerar um relatório para verificar se a configuração do ollama está correta:
```
python src/command_tool.py
```
Se configurado corretamente, você poderá gerar relatórios através do modelo Ollama.

Teste de unidade

Para garantir a qualidade e a confiabilidade do código, o GitHub Sentinel usa o módulo unittest para testes de unidade. Para descrições detalhadas do unittest e suas ferramentas relacionadas, como @patch e MagicMock , consulte os detalhes do teste da unidade.

Script de teste e validação de unidade `validate_tests.sh`

usar

validate_tests.sh é um script de shell que executa testes de unidade e valida os resultados. Ele é executado durante o processo de criação de imagem do Docker para garantir a correção e a estabilidade do código.

Função

O script executa todos os testes de unidade e produz os resultados no arquivo test_results.txt .
Se o teste falhar, o script produzirá os resultados do teste e faz com que a compilação do Docker falhe.
Se todos os testes passarem, o script continuará construindo o processo.

Construa e verifique com o Docker

Para facilitar a construção e implantação de projetos do GitHub Sentinel em vários ambientes, fornecemos suporte ao Docker. Este suporte inclui os seguintes arquivos e recursos:

1. `Dockerfile`

usar

Dockerfile é um arquivo de configuração usado para definir como criar uma imagem do Docker. Ele descreve as etapas para construir a imagem, incluindo a instalação de dependências, copiando arquivos de projeto, testes de unidade em execução, etc.

Etapas -chave

Use python:3.10-slim como a imagem base e defina o diretório de trabalho para /app .
Copie o arquivo requirements.txt do projeto e instale as dependências do Python.
Copie todos os arquivos do projeto para o contêiner e forneça validate_tests.sh .
Execute o script validate_tests.sh durante o processo de construção para garantir que todos os testes de unidade passem. Se o teste falhar, o processo de construção será abortado.
Depois que a construção for bem -sucedida, src/main.py será executado por padrão como ponto de entrada do contêiner.

2. `build_image.sh`

usar

build_image.sh é um script de shell para criar imagens automaticamente do docker. Ele pega o nome da ramificação do ramo Git atual e o usa como uma etiqueta para a imagem do Docker, facilitando a geração de imagens diferentes do Docker em diferentes ramificações.

Função

Obtém o nome atual do ramo Git e o usa como um rótulo para a imagem do Docker.
Use o comando docker build para criar a imagem do Docker e use o nome atual do ramo Git como o rótulo.

Exemplo de uso

chmod +x build_image.sh
./build_image.sh

build_docker_image

Através desses scripts e arquivos de configuração, é garantido que, em diferentes ramificações de desenvolvimento, as imagens do Docker construídas sejam baseadas em código testado na unidade, melhorando assim a qualidade do código e a confiabilidade da implantação.

contribuir

A contribuição é o que torna a comunidade de código aberto incrível de aprender, inspirar e criar. Muito obrigado por qualquer contribuição que você tenha dado. Se você tiver alguma sugestão ou solicitações de recursos, inicie um tópico para discutir o que deseja alterar.