Português (BR) | English (US)

API

Dentro do ecossistema do Querido Diário, este repositório é responsável por manter o código-fonte da API que disponibiliza os diários oficiais raspados.

Conheça mais sobre as tecnologias e a história do projeto no site do Querido Diário

Sumário

• Documentação
• Como contribuir
• Ambiente de desenvolvimento
• Como executar
  • Usando o endpoint de ‘sugestões’
• Testes
• Suporte
• Agradecimentos
• Open Knowledge Brasil
• Licença

Como contribuir

Agradecemos por considerar contribuir com o Querido Diário! 🎉

Você encontra como fazê-lo no CONTRIBUTING.md!

Além disso, consulte a documentação do Querido Diário para te ajudar.

Documentação

Veja a documentação da API em queridodiario.ok.org.br/api/docs

Ambiente de desenvolvimento

No momento, o projeto é compatível apenas com ambientes Linux. Ele é construído e executado em contêineres podman. A API é desenvolvida em Python (3.6+) utilizando as bibliotecas FastAPI e Pydantic.

Com o podmaninstalado em sua máquina, utilize o comando a seguir em um terminal aberto na raiz do repositório para construir a imagem do contêiner da API:

make build

Veja a seção "como configurar o ambiente de desenvolvimento" para mais detalhes, incluindo informações para quem deseja contribuir com o desenvolvimento do repositório.

Como executar

Para executar a API localmente em sua máquina, use o seguinte comando:

make run

Esse comando iniciará todos os contêineres necessários para executar a API. Ou seja, ele inicializa o banco de dados e o contêiner da API. Se tudo correr bem, você poderá fazer consultas à API em localhost:8080/gazettes/<City IBGE Code>

ATENÇÃO: Quando você precisar reiniciar a API, apenas interrompa o processo da API e execute o make rerun novamente. Não é necessário reiniciar o banco de dados.

Você pode checar toda a documentação interativa da API em localhost:8080/docs. Nessa página, você pode fazer requisições à API diretamente. Mas, para vê-la funcionar, você precisa inserir dados no índice. Há outro comando, make load-data, que insere alguns exemplos de entrada no índice principal.

Usando o endpoint de ‘sugestões’

O endpoint de sugestões no Querido Diário é uma forma de coletar feedback dos usuários e usa o serviço do Mailjet para enviar e-mails. É necessário criar um token de acesso em Mailjet para executar a aplicação e enviar e-mails (salve em config/current.env).

Suporte

Ingresse em nosso canal de comunidade para trocas sobre os projetos, dúvidas, pedidos de ajuda com contribuição e conversar sobre inovação cívica em geral.

Agradecimentos

Este projeto é mantido pela Open Knowledge Brasil e possível graças às comunidades técnicas, às Embaixadoras de Inovação Cívica, às pessoas voluntárias e doadoras financeiras, além de universidades parceiras, empresas apoiadoras e financiadoras.

Conheça quem apoia o Querido Diário.

Open Knowledge Brasil

A Open Knowledge Brasil é uma organização da sociedade civil sem fins lucrativos, cuja missão é utilizar e desenvolver ferramentas cívicas, projetos, análises de políticas públicas, jornalismo de dados para promover o conhecimento livre nos diversos campos da sociedade.

Todo o trabalho produzido pela OKBR está disponível livremente.

Licença

Código licenciado sob a Licença MIT.