Português (BR) | English (US)

API wrapper

Dentro do ecossistema do Querido Diário, este repositório fornece uma biblioteca simples para acessar e consultar a API do projeto.

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

Sumário

• Como contribuir
• Como executar
  • Exemplos de uso
• 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.

Como executar

Para utilizar a biblioteca querido_diario é necessário ter Python (3.8+) instalado.

1. Em um terminal aberto, obtenha a biblioteca:

pip install querido-diario-api-wrapper

2. Para usar, importe a biblioteca em seu código em Python.

import querido_diario

Exemplos de uso

A busca por palavra-chave é limitada e ainda não conseguimos isolar as partes dos Diários. Por isso, buscar por palavras muito genéricas pode retornar uma quantidade de resultados muito grande e possivelmente pouco interessantes. Por exemplo, se procurarmos por "prefeito", é bem provável que todos os Diários contenham essa palavra.

Este projeto fornece uma maneira mais simples de se acessar essa API e fazer consultas a ela. Conforme a API evoluir, esse projeto também será atualizado. Para sugestões de melhorias, erros, tipos de consultas que seriam interessantes de se adicionar, abra uma Issue para que possa ser avaliado.

Consulta lista de municípios disponíveis

In [1]: import querido_diario

In [2]: querido_diario.TERRITORIES

Consulta de palavras-chave em dado período por cidade

Armazena em gazettes todos os diários entre 01/01/2020 e 31/01/2021 que contêm as palavras "covid" e "cloroquina" do município de código (IBGE) 2408102 (Natal-RN)

In [1]: import querido_diario

In [2]: gazettes = querido_diario.gazettes(
      since="2020-01-01",
      until="2021-01-31",
      keywords=["covid", "cloroquina"],
      territory_id="1302603",
      offset=0,
      size=10
      )

In [3]: gazettes

Out[3]: 
  {
    "total_gazettes": 1,
    "gazettes": [
      {
        "territory_id": "2408102",
        "date": "2020-07-31",
        "url": "https://querido-diario.nyc3.cdn.digitaloceanspaces.com/2408102/2020-07-31/64e13a14bfe1f03b39cfe9d4a194070539fd6fe3.pdf",
        "territory_name": "Natal",
        "state_code": "RN",
        "is_extra_edition": false
      }
    ]
  }

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.