Atualiza documentações do repositório

Adiciona CONTRIBUTING.md e sua tradução em inglês Adiciona FUNDING.yml Adiciona SUPPORT.md e sua tradução Move e renomeia tradução do README.md Atualiza texto de LICENSE.md Atualiza e move arquivos para /docs
okfn-brasil · Aug 10, 2023 · 223b0e7 · 223b0e7
1 parent aa199f9
commit 223b0e7
Show file tree

Hide file tree

Showing 15 changed files with 268 additions and 124 deletions.
diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Open Knowledge Foundation Brasil
+Copyright (c) 2021 Open Knowledge Brasil - Rede pelo Conhecimento Livre
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
diff --git a/docs/CODE_OF_CONDUCT-en-US.md b/docs/CODE_OF_CONDUCT-en-US.md
@@ -0,0 +1,9 @@
+**English (US)** | [Português (BR)](/docs/CODE_OF_CONDUCT.md)
+
+# Contributor Covenant Code of Conduct
+
+We expect all people to respect and be respected, regardless of any diversity.
+
+To ensure this, we have derived this document from the [**Querido Diário Code of Conduct**](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CODE_OF_CONDUCT-en-US.md).
+
+If you intend to participate in our community, we ask that you read it and follow the guidelines described therein.
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+**Português (BR)** | [English (US)](/docs/CODE_OF_CONDUCT-en-US.md)
+
+# Código de Conduta de Colaboração
+
+Esperamos que todas as pessoas respeitem e sejam respeitadas, independentemente de qualquer diversidade.
+
+Para garantir isso, derivamos este documento do [**Código de Conduta do Querido Diário**](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CODE_OF_CONDUCT.md).
+
+Caso você tenha o objetivo de participar da nossa comunidade, pedimos que o leia e siga as diretrizes nele descritas.
diff --git a/docs/CONTRIBUTING-en-US.md b/docs/CONTRIBUTING-en-US.md
@@ -0,0 +1,7 @@
+**English (US)** | [Português (BR)](/docs/CONTRIBUTING.md)
+
+# Contributing
+Querido Diário has a [Guide for Contributing](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CONTRIBUTING-en-US.md#contributing) that is relevant to all of its repositories. The guide provides general information about how to interact with the project, the code of conduct you adhere to when contributing, the list of ecosystem repositories and the first actions you can take. We recommend reading it before continuing.
+
+# Maintaining
+Maintainers must follow the guidelines in Querido Diário's [Guide for Maintainers](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CONTRIBUTING-en-US.md#maintaining).
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1,72 @@
+**Português (BR)** | [English (US)](/docs/CONTRIBUTING-en-US.md)
+
+# Contribuindo
+O Querido Diário possui um [Guia para Contribuição](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CONTRIBUTING.md#contribuindo) principal que é relevante para todos os seus repositórios. Este guia traz informações gerais sobre como interagir com o projeto, o código de conduta que você adere ao contribuir, a lista de repositórios do ecossistema e as primeiras ações que você pode tomar. Recomendamos sua leitura antes de continuar.
+
+Já leu? Então vamos às informações específicas deste repositório:
+- [Arquitetura](#arquitetura)
+- [Como configurar o ambiente de desenvolvimento](#como-configurar-o-ambiente-de-desenvolvimento)
+    - [Em Linux](#em-linux)
+- [Testes](#testes)
+
+## Arquitetura
+![arquitetura](/docs/images/arquitetura.png)
+
+ Abaixo, uma breve descrição de seus componentes: 
+| **Tipo**  | **Nome**                                           | **Descrição**                                                                                      | **Dependências**                    |
+|-----------|----------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------|
+| Aplicação | [`api`](/api)                                      | Configuração e criação de endpoints da API.                                                        | _serviços e recursos_               |
+| Aplicação | [`main`](/main)                                    | Configuração e execução da API.                                                                    | _api, serviços, módulos e recursos_ |
+| Serviço   | [`cities`](/cities)                                | Consultas ao banco do [Censo de Diários Municipais](https://censo.ok.org.br).                      | Banco de dados do Censo             |
+| Serviço   | [`companies`](/companies)                          | Consultas ao banco de dados de CNPJ.                                                               | database                            |
+| Serviço   | [`gazettes`](/gazettes)                            | Consultas ao índice de busca textual principal do QD.                                              | index                               |
+| Serviço   | [`suggestions`](/suggestions)                      | Envio de emails de sugestão.                                                                       | Mailjet                             |
+| Serviço   | [`themed_excerpts`](/themed_excerpts)              | Consultas ao índices de busca textual temáticos do QD.                                             | index                               |
+| Módulo    | [`database`](/database)                            | Classe de interação com bancos de dados Postgres.                                                  | Postgres                            |
+| Módulo    | [`config`](/config)                                | Configuração de variáveis de ambiente.                                                             |                                     |
+| Módulo    | [`index`](/index)                                  | Classe de interação com índices Elasticsearch.                                                     | Elasticsearch                       |
+| Recurso   | Postgres                                           | Banco de dados de CNPJ. Contém informações sobre empresas e sócios cadastrados na Receita Federal. |                                     |
+| Recurso   | Banco de dados do [Censo](https://censo.ok.org.br) | Banco de dados de municípios. Contém metadados municipais.                                         |                                     |
+| Recurso   | Elasticsearch                                      | Índices de busca textual.                                                                          |                                     |
+| Recurso   | Mailjet                                            | Serviço de envio de email.                                                                         |                                     |
+
+## Como configurar o ambiente de desenvolvimento
+
+### Em Linux
+
+A API é construída e executada em contêineres [`podman`](https://podman.io/). Para conhecer mais sobre o `podman`, veja esta [postagem da Red Hat](https://www.redhat.com/pt-br/topics/containers/what-is-podman) ou navegue nos [tutoriais](https://docs.podman.io/en/latest/Tutorials.html) de sua documentação. E é desenvolvida em [Python](https://docs.python.org/3/) (3.6+) utilizando as bibliotecas [FastAPI](https://fastapi.tiangolo.com/) e [Pydantic](https://docs.pydantic.dev/), assim como outras bibliotecas que permitem interação com os recursos da tabela acima. 
+
+1. Instale o [`podman`](https://podman.io/) em sua máquina. Ele existe em quase todos os repositórios de pacotes de distribuição Linux. Consulte a [documentação do podman](https://podman.io/getting-started/installation.html) para entender como instalá-lo na distribuição que utiliza.
+
+2. Abra um terminal no diretório do seu clone deste repositório
+
+3. Construa a imagem do contêiner usado no desenvolvimento com o seguinte comando: 
+```
+make build
+```
+
+4. Pronto! Com isso, você terá uma imagem do contêiner que poderá executar a API localmente no processo de desenvolvimento.
+
+
+## Testes
+Este projeto foi desenvolvido com o paradigma TDD (Test Driven-Development). Isso significa que não há mudanças sem testes. Devemos sempre buscar ter uma cobertura de testes de todo código-fonte. Outra maneira de encarar os testes é o seguinte:
+
+> “Escreva o teste que o força a escrever o código que você já sabe que quer escrever” 
+> Por Robert C. Martin (a.k.a. Uncle Bob), tradução nossa.
+
+Para executar os testes, faça o seguinte:
+
+```bash
+make test
+```
+
+ATENÇÃO: Não é necessário reiniciar a base de teste a cada vez que você quiser executar os testes. Uma vez que o banco de dados esteja em execução, você só precisa rodar o  `make retest` novamente. Se você remover o banco de dados com `make destroydatabse` ou reiniciar a máquina, você terá que iniciar o banco de dados novamente. 
+
+Para checar a cobertura do código:
+
+```bash
+make coverage
+```
+
+# Mantendo
+As pessoas mantenedoras devem seguir as diretrizes do [Guia para Mantenedoras](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CONTRIBUTING.md#mantendo) do Querido Diário.
diff --git a/docs/FUNDING.yml b/docs/FUNDING.yml
@@ -0,0 +1 @@
+custom: ["https://queridodiario.ok.org.br/apoie/"]
diff --git a/docs/README-en-US.md b/docs/README-en-US.md
@@ -0,0 +1,56 @@
+**English (US)** | [Português (BR)](/docs/README.md) 
+
+<p align="center">
+  <a href="https://queridodiario.ok.org.br/sobre" target="_blank"> <img alt="Querido Diário" src="./images/querido-diario-logo.png" width="200">
+  </a>
+</p>
+
+# API
+
+Find out more about [technologies](https://queridodiario.ok.org.br/tecnologia) and [history](https://queridodiario.ok.org.br/sobre) of the project on the [Querido Diário website](https://queridodiario.ok.org.br)
+
+# Summary
+- [How to contribute](#how-to-contribute)
+- [Support](#support)
+- [Thanks](#thanks)
+- [Open Knowledge Brazil](#open-knowledge-brazil)
+- [License](#license)
+
+# How to contribute
+<p>  
+  <a href="https://www.catarse.me/queridodiario-okbr" target="_blank"> 
+    <img alt="catarse" src="https://img.shields.io/badge/Catarse-Apoie%20o%20projeto-orange?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDMyNSA0NTUiIHdpZHRoPSIzMjUiIGhlaWdodD0iNDU1Ij4KCTx0aXRsZT5sb2dvLXYtY29yLXBvc2l0aXZvLWFpPC90aXRsZT4KCTxzdHlsZT4KCQkuczAgeyBmaWxsOiAjMTdhMzM4IH0gCgkJLnMxIHsgZmlsbDogIzdkYjkzZCB9IAoJCS5zMiB7IGZpbGw6ICNmMmJmMDAgfSAKCQkuczMgeyBmaWxsOiAjZjE5MTA2IH0gCgkJLnM0IHsgZmlsbDogI2VhNjYwYiB9IAoJCS5zNSB7IGZpbGw6ICNkZTMyODEgfSAKCTwvc3R5bGU+Cgk8ZyBpZD0iTGF5ZXIgMSI+CgkJPGcgaWQ9IiZsdDtHcm91cCZndDsiPgoJCQk8cGF0aCBpZD0iJmx0O1BhdGgmZ3Q7IiBjbGFzcz0iczAiIGQ9Im01Ni40IDI1Ni40cS0xLjggMy4xLTMuNCA2LjRjLTE1LjQgMzMuMS00LjcgNjMuMSAxNC44IDkyLjQgMTEuNiAxNy40IDguNiAzNi40LTEuOSA0Ny4zLTYgNi4zLTE0LjUgOS44LTIzLjIgOS43LTQuNSAwLTkuMS0wLjktMTMuNS0zLTYuMy0yLjktMTUuMS05LjEtMjIuMi0yOC43LTguOS0yNC4yLTkuMS01MS42IDIuNi03Ni44IDEwLjEtMjEuNiAyNi45LTM3LjggNDYuOC00Ny4zeiIvPgoJCQk8cGF0aCBpZD0iJmx0O1BhdGgmZ3Q7IiBjbGFzcz0iczEiIGQ9Im00Ni41IDMwNS44YzAuNSAyLjYgMSA1LjIgMS43IDcuOCAxMC41IDM4LjcgNDAuNyA1Ni41IDc3LjggNjcuNCAyMi4xIDYuNSAzMyAyNC43IDMxLjkgNDEuMi0wLjcgOS42LTUuMyAxOC41LTEyLjcgMjQuNi0zLjggMy4yLTguNCA1LjctMTMuNSA3LTcuNCAyLTE5LjIgMy0zOS4xLTguNC0yNC41LTE0LjItNDQuMS0zNy4yLTUyLTY2LjctNi44LTI1LjItNC4xLTUwLjggNS45LTcyLjl6Ii8+CgkJCTxwYXRoIGlkPSImbHQ7UGF0aCZndDsiIGNsYXNzPSJzMiIgZD0ibTczLjIgMzU0LjVjMi4yIDEuOCA0LjUgMy42IDYuOSA1LjMgMzYuMiAyNS4zIDc0LjMgMTguOSAxMTMuMiAxLjggMjMuMi0xMC4xIDQ1LjMtMi41IDU2IDEyLjIgNi4zIDguNiA4LjYgMTkuNCA2LjggMjkuNy0xIDUuNC0zLjEgMTAuNy02LjUgMTUuNS00LjggNi45LTE0IDE2LjEtMzguOSAyMC41LTMwLjcgNS40LTYzLjQtMC4xLTkwLjktMTkuNC0yMy42LTE2LjUtMzkuNC0zOS45LTQ2LjYtNjUuNnoiLz4KCQkJPHBhdGggaWQ9IiZsdDtQYXRoJmd0OyIgY2xhc3M9InMzIiBkPSJtMTMwLjEgMzc2LjZxNC43IDAuMSA5LjUtMC40YzQ4LjQtNC4zIDc2LTM2LjUgOTYuNy03OC41IDEyLjQtMjUgMzYuNC0zNC4xIDU1LjgtMjkuMyAxMS40IDIuOCAyMSAxMC4yIDI2LjcgMjAuMyAzIDUuMiA1IDExLjEgNS41IDE3LjYgMC45IDkuMi0wLjQgMjMuNC0xOC4zIDQ0LjctMjIgMjYuMy01My41IDQ0LjgtOTAuMyA0OC0zMS41IDIuOC02MS40LTUuOC04NS42LTIyLjR6Ii8+CgkJCTxwYXRoIGlkPSImbHQ7UGF0aCZndDsiIGNsYXNzPSJzNCIgZD0ibTE5My42IDM1NS4xYzIuNy0yLjIgNS4zLTQuNiA3LjgtNy4xIDM3LjctMzcuOCAzOC4xLTg0LjUgMjUuOS0xMzQuNS03LjItMjkuOCA2LjUtNTQuNSAyNi4zLTY0LjIgMTEuNS01LjYgMjQuOS02LjEgMzYuOC0xLjggNi4zIDIuMyAxMi4xIDUuOSAxNy4xIDExIDcuMiA3LjEgMTYuMiAyMC4xIDE2LjMgNTAuNiAwIDM3LjctMTMuNSA3NS42LTQyLjIgMTA0LjMtMjQuNiAyNC43LTU1LjkgMzguNi04OCA0MS43eiIvPgoJCQk8cGF0aCBpZD0iJmx0O1BhdGgmZ3Q7IiBjbGFzcz0iczUiIGQ9Im0yMzEuOSAyOTJjMC44LTQuNCAxLjQtOC45IDEuOC0xMy41IDYtNjkuMi0zMi42LTExNi04Ni41LTE1NS43LTMyLjItMjMuNi0zOS4xLTU5LjYtMjcuNS04NS44IDYuNy0xNS4zIDE5LjctMjcgMzUuMi0zMi42IDguMS0yLjkgMTctNC4yIDI2LjEtMy40IDEzLjIgMS4xIDMzIDYuNSA1OC42IDM2LjkgMzEuNSAzNy41IDQ5LjcgODYuNSA0NS4xIDEzOS4xLTMuOSA0NS4xLTIzLjQgODUuMS01Mi44IDExNXoiLz4KCQk8L2c+Cgk8L2c+Cjwvc3ZnPg==">
+  </a>
+</p> 
+
+Thank you for considering contributing to Querido Diário! :tada:
+
+You can find how to do it at [CONTRIBUTING-en-US.md](/docs/CONTRIBUTING-en-US.md)!
+
+Also, check the [Querido Diário documentation](https://docs.queridodiario.ok.org.br/pt/latest/index.html) to help you.
+
+# Thanks
+This project is maintained by Open Knowledge Brazil and made possible thanks to the technical communities, the [Ambassadors of Civic Innovation](https://embaixadoras.ok.org.br/), volunteers and financial donors, in addition to partner universities, companies supporters and funders.
+
+Meet [who supports Querido Diário](https://queridodiario.ok.org.br/apoie#quem-apoia).
+
+# Open Knowledge Brazil
+<p>
+  <a href="https://twitter.com/okfnbr" target="_blank">
+    <img alt="Twitter Follow" src="https://img.shields.io/badge/Twitter-_-blue?style=for-the-badge&logo=twitter">
+  </a>
+  <a href="https://www.instagram.com/openknowledgebrasil/" target="_blank">
+    <img alt="Instagram Follow" src="https://img.shields.io/badge/Instagram-_-red?style=for-the-badge&logo=instagram">
+  </a>
+  <a href="https://www.linkedin.com/company/open-knowledge-brasil" target="_blank">
+    <img alt="LinkedIn Follow" src="https://img.shields.io/badge/LinkedIn-_-9cf?style=for-the-badge&logo=linkedin">
+  </a>
+</p>
+
+[Open Knowledge Brazil](https://ok.org.br/) is a non-profit civil society organization whose mission is to use and develop civic tools, projects, public policy analysis and data journalism to promote free knowledge in the various fields of society.
+
+All work produced by OKBR is openly and freely available.
+
+# License
+
+Code licensed under the [MIT License](/LICENSE.md).