Skip to content

Um chatbot para ajudar a população a fiscalizar seus candidatos

License

Notifications You must be signed in to change notification settings

ricardochaves/dragon-of-justice

Repository files navigation

Dragon of Justice

Build Status Maintainability Coverage Status Codacy Badge Updates Python 3


Um chatbot (atualmente com suporte ao Telegram) que utiliza parte da stack do Serenata de Amor para identificar atividades suspeitas de deputados federais.

O objetivo do projeto é dar poder a qualquer pessoa / organização de criar o seu próprio chatbot fazendo com que mais e mais pessoas tenha acesso a informações que vão ajuda-las a cobrar os seus deputados.

Para desenvolver

Faça um clone do projeto

git clone git@github.com:ricardochaves/dragon-of-justice.git

Entre na pasta

cd dragon-of-justice

Crie um arquivo .env baseado no example.env

cp example.env .env

Crie um bot no telegram

Atualmente o bot só tem suporte para o telegram, mas ele está sendo desenvolvido com a ideia de se plugar mais bots ao bot core.

Você precisa criar um bot no Telegram e adicionar o token no seu arquivo .env. Para criar um token você pode ver a documentação oficial do Telegran.

MongoDB

Se você quiser manter os dados persistidos no banco de dados crie um diretório ./data/db e adicione o volume no docker-compose.yml. Ele vai ficar parecido com o exemplo abaixo.

services:
  mongodb:
    image: mongo:3.6.0
    ports:
      - "27017:27017"
    volumes:
      - ./data/db:/data/db

Para rodar o projeto basta executar docker-compose up

Testes

Para executar os testes:

docker-compose run bot nosetests

Se você gosta de ver os testes durante o desenvolvimento use o watch

docker-compose run bot nosetests --with-watch

Existe a opção de usar com converage

docker-compose run bot nosetests --with-watch --with-coverage --cover-package=.

Code Climate

Para evitar que o PR tenha problemas com o Code Climate você pode rodar ele localmente primeiro. Primeiro instale o CLI. Veja como instalar aqui

Após a instalação baixe as imagens do docker dos plugins, no diretório root faça:

codeclimate engines:install

Isso pode demorar...

Depois que ele baixar as imagens execute:

codeclimate analyze

O resultado esperado é:

>>codeclimate analyze
Starting analysis
Running structure: Done!
Running duplication: Done!
Running pep8: Done!
Running markdownlint: Done!

Analysis complete! Found 0 issues.

About

Um chatbot para ajudar a população a fiscalizar seus candidatos

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published