https://github.com/dadosabertosdefeira/diario-de-feira

O que acontece em Feira pelo Diário Oficial 🤖
https://github.com/dadosabertosdefeira/diario-de-feira

bot diario-oficial feira-de-santana hacktoberfest python tecnologias-civicas twitter

Last synced: 1 day ago
JSON representation

O que acontece em Feira pelo Diário Oficial 🤖

• Host: GitHub
• URL: https://github.com/dadosabertosdefeira/diario-de-feira
• Owner: DadosAbertosDeFeira
• License: mit
• Created: 2021-06-04T20:28:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-06T22:19:32.000Z (almost 2 years ago)
• Last Synced: 2024-05-22T21:25:38.956Z (6 months ago)
• Topics: bot, diario-oficial, feira-de-santana, hacktoberfest, python, tecnologias-civicas, twitter
• Language: Python
• Homepage: https://twitter.com/DiarioDeFeira
• Size: 79.1 KB
• Stars: 8
• Watchers: 5
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Diário de Feira

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

[![CI](https://github.com/DadosAbertosDeFeira/diario-de-feira/actions/workflows/cicd.yml/badge.svg)](https://github.com/DadosAbertosDeFeira/diario-de-feira/actions/workflows/cicd.yml) [![Agendamento de postagens de tweets](https://github.com/DadosAbertosDeFeira/diario-de-feira/actions/workflows/schedule.yml/badge.svg)](https://github.com/DadosAbertosDeFeira/diario-de-feira/actions/workflows/schedule.yml)

## 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](https://www.python.org/downloads/) instalado na sua máquina, aqui estamos usando a versão 3.9.5.

    - Ter também, o [Poetry](https://python-poetry.org/docs/master/#installation) 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

```