Diário de Feira

Um bot para informar a população sobre o que acontece no Diário Oficial. 📰

Visão

A ideia desse projeto é ser um serviço genérico de acesso a uma fonte de dados (APIs) que disponibilizam informações sobre a publicação de edições do Diário Oficial de um município e as publica em outros locais para serem vistos e acessados pela população (e.g. Twitter, Discord).

Configurando o ambiente

• Alguns pré-requisitos necessários:
  • Ter o Python instalado na sua máquina, aqui estamos usando a versão 3.9.5.
  • Ter também, o Poetry instalado na sua máquina. É com ele que vamos gerenciar todas as nossas dependências e criar nosso ambiente virtual.
• Após a instalação do Poetry, vamos instalar as dependências usando:

poetry install

• Depois iremos iniciar o ambiente virtual usando o shell do poetry:

poetry shell

Execute também o pre-commit install e pre-commit para garantir que o seu código esteja formatado de acordo com o estilo do projeto a cada commit novo.

Configurando variáveis de ambiente

As variáveis de ambiente deverão ser incluídas em um arquivo chamado .env. Deixamos o arquivo .env-sample na raíz do projeto pra ser usado como referência na criação do seu arquivo .env. Nele estão todas as variáveis que o projeto necessita.

Rodando o projeto

Para postar diário do dia corrente, entre no seu ambiente virtual e rode:

diario_bot

Caso queira rodar o projeto mas buscando diário de algum dia anterior, só incluir a data no formato YYYY-MM-DD, na hora de rodar o projeto, dessa forma:

diario_bot --data YYYY-MM-DD

Se caso queira rodar o projeto sem postar os tweets, mas mesmo assim conseguir acompanhar os logs, use:

diario_bot --dry-run

Executando os testes

Para rodar os testes basta executar:

pytest