From dd37b9d3f225278265db93f7abc1566005d225cb Mon Sep 17 00:00:00 2001 From: Ricardo Dahis Date: Tue, 12 Nov 2024 16:40:05 +1100 Subject: [PATCH] adjust docs: mais to sdk --- .github/CONTRIBUTING.md | 6 +++--- .gitignore | 8 ++------ CITATION.cff | 6 +++--- CONTRIBUTING.md | 20 ++++++++++---------- docs/docs/pt/access_data_bq.md | 2 +- docs/mkdocs.yml | 6 +++--- r-package/DESCRIPTION | 2 +- r-package/R/zzzz.R | 2 +- stata-package/Minitutorial.md | 2 +- stata-package/README.md | 2 +- 10 files changed, 26 insertions(+), 30 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 165fc44ac..d698f5099 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,7 +8,7 @@ Incentivamos que outras instituições e pessoas contribuam conosco. Para colabo 2. Revisar ao longo da semana e colocar sua solicitação como `priority` caso necessário 3. Redesignar alguém para cuidar da solicitação caso necessário -Caso você possa colaborar subindo a base, sinalize isso na sua solicitação. É requerido somente que o processo de captura e tratamento sejam públicos e documentados, e a inserção dos dados no BigQuery siga [nossa metodologia](https://basedosdados.github.io/mais/colab_data/). +Caso você possa colaborar subindo a base, sinalize isso na sua solicitação. É requerido somente que o processo de captura e tratamento sejam públicos e documentados, e a inserção dos dados no BigQuery siga [nossa metodologia](https://basedosdados.github.io/sdk/colab_data/). # Contribuindo com código (CLI) Precisamos de ajuda para manter e melhorar nossos clientes Python, R, entre outros. Acesse nossos issues ou abra um novo para começar a desenvolver :) @@ -16,13 +16,13 @@ Precisamos de ajuda para manter e melhorar nossos clientes Python, R, entre outr ## Teve algum erro? Utilize o template "Bugs" #### O que acontece? -- Mantenedorxs vão: +- Mantenedores vão: 1. Revisar ao longo da semana e colocar sua solicitação como `priority` caso necessário 2. Redesignar alguém para cuidar da solicitação caso necessário ## Tem sugestão de features ou pacotes em novas linguagens? Utilize o template "Novas funcionalidades" #### O que acontece? -- Mantenedorxs vão: +- Mantenedores vão: 1. Revisar ao longo da semana e colocar sua solicitação como `priority` caso necessário 2. Redesignar alguém para cuidar da solicitação caso necessário diff --git a/.gitignore b/.gitignore index be57c57a0..c831571e5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,10 @@ # OLD repo name .bases .mais +.sdk bases/pytest/* bases/test/ +pytest/* test/* test.py @@ -10,12 +12,6 @@ test.py .DS_Storage */*/.DS_Storage - -# NEW repo name -.mais -mais/pytest/* -mais/test/ - bases/*/input/ bases/*/tmp/ bases/*/output/ diff --git a/CITATION.cff b/CITATION.cff index 3a64f17b6..0e5cfcd45 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,9 +1,9 @@ cff-version: 1.1.0 message: "If you use this software, please cite it as below." -title: "Base dos Dados Mais" +title: "Base dos Dados" authors: - name: "Base dos Dados" url: "https://basedosdados.org" license: MIT -license-url: "https://github.com/basedosdados/mais/blob/master/LICENSE" -repository-code: https://github.com/basedosdados/mais +license-url: "https://github.com/basedosdados/sdk/blob/master/LICENSE" +repository-code: https://github.com/basedosdados/sdk diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7730bcd64..0138bbd9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ # CONTRIBUTING -O repositório `mais` contém o código base para os pacotes de **BD** em Python, R e Stata. Neste documento, detalhamos a configuração de ambiente necessária para contribuir em cada um dos nossos pacotes. +O repositório `sdk` contém o código base para os pacotes de **BD** em Python, R e Stata. Neste documento, detalhamos a configuração de ambiente necessária para contribuir em cada um dos nossos pacotes. ## Python Clone o repositório principal: ```sh -git clone https://github.com/basedosdados/mais.git +git clone https://github.com/basedosdados/sdk.git ``` -Entre na pasta local do repositório usando `cd mais/` e suba o ambiente localmente: +Entre na pasta local do repositório usando `cd sdk/` e suba o ambiente localmente: ```sh make create-env -. .mais/bin/activate +. .sdk/bin/activate cd python-package/ python setup.py develop ``` @@ -26,23 +26,23 @@ Após esses passos, seu ambiente estará configurado e você pode criar uma nova __Passo 1.__ Clique [aqui](https://www.python.org/downloads/) na opção "Download Python" para baixar o Python. Em seguida, siga as instruções da tela e, principalmente, _não esqueça_ de marcar a opção "add to path":

- - Base dos Dados Mais + + Base dos Dados

__Passo 2.__ Após instalar o Python, abra o menu iniciar, digite "cmd" e abra. Na tela do "Prompt de Comando" que aparecerá, digite `pip install basedosdados -U` e dê enter.

- - Base dos Dados Mais + + Base dos Dados

__Passo 3.__ Após concluir a instalação do pacote basedosdados, digite `basedosdados reauth` no Prompt de Comando. Copie o link que aparecerá, cole na sua aba de navegação e dê autorização ao google. Em seguida, copie o código gerado, volte e cole na tela do Prompt e dê enter. -> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/mais/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). +> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/sdk/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). -Após finalizar esses 3 passos, já será possível abrir o Stata e começar a usar o pacote. Para saber mais sobre os comandos do pacote, leia esse manual [aqui](https://github.com/basedosdados/mais/tree/master/stata-package). +Após finalizar esses 3 passos, já será possível abrir o Stata e começar a usar o pacote. Para saber mais sobre os comandos do pacote, leia esse manual [aqui](https://github.com/basedosdados/sdk/tree/master/stata-package). Com a conclusão da configuração do ambiente, você pode criar uma nova branch para desenvolver uma nova feature.. \ No newline at end of file diff --git a/docs/docs/pt/access_data_bq.md b/docs/docs/pt/access_data_bq.md index 36d83f543..ab8bafd32 100644 --- a/docs/docs/pt/access_data_bq.md +++ b/docs/docs/pt/access_data_bq.md @@ -97,7 +97,7 @@ Só clicar em **Executar** e pronto! Está seção é dedicada a apresentar dicas de como reduzir custos de processamento para aproveitar ao máximo os dados da BD! -Para usuários que acessam os dados em projetos públicos como o da Base dos Dados o único tipo de custo associado se refere ao custo de **processamento das consultas**. A notícia boa, como mencionado acima, é que todo usuário possui *1 TB gratuito por mês para consultar livremente os dados do maior data lake público do Brasil*. Se você ainda não possui um projeto no BQ consulte [a sessão acima](https://basedosdados.github.io/mais/access_data_bq/#primeiros-passos) para criá-lo. +Para usuários que acessam os dados em projetos públicos como o da Base dos Dados o único tipo de custo associado se refere ao custo de **processamento das consultas**. A notícia boa, como mencionado acima, é que todo usuário possui *1 TB gratuito por mês para consultar livremente os dados do maior data lake público do Brasil*. Se você ainda não possui um projeto no BQ consulte [a sessão acima](#primeiros-passos) para criá-lo. - Conhecer o básico da interface do BQ é importante para o entendimento do artigo. Caso você não tenha familiariadade ou queria revisitar a interface, sugerimos 3 trilhas: 1. Nosso guia utilizando as [tabelas da RAIS - Relação Anual de Informações Sociais](https://dev.to/basedosdados/bigquery-101-45pk) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d4da56984..3303beef3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -27,8 +27,8 @@ theme: - navigation.top - toc.integrate -repo_url: https://github.com/basedosdados/mais -repo_name: basedosdados/mais +repo_url: https://github.com/basedosdados/sdk +repo_name: basedosdados/sdk extra: version: 2.0 @@ -38,7 +38,7 @@ extra: - icon: fontawesome/brands/discord link: https://discord.com/invite/huKWpsVYx4 - icon: fontawesome/brands/github - link: https://github.com/basedosdados/mais + link: https://github.com/basedosdados/sdk - icon: fontawesome/brands/linkedin link: https://www.linkedin.com/in/basedosdados - icon: fontawesome/brands/whatsapp diff --git a/r-package/DESCRIPTION b/r-package/DESCRIPTION index c1d976178..c4a501071 100644 --- a/r-package/DESCRIPTION +++ b/r-package/DESCRIPTION @@ -16,7 +16,7 @@ Authors@R: role = c("aut"), email = "rodornelles@gmail.com", comment = c(ORCID = "0000-0003-3709-4760"))) -Description: An R interface to the 'Base dos Dados' API ). Authenticate your project, query our tables, save data to disk and memory, all from R. +Description: An R interface to the 'Base dos Dados' API ). Authenticate your project, query our tables, save data to disk and memory, all from R. License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) diff --git a/r-package/R/zzzz.R b/r-package/R/zzzz.R index 97a89d4ad..6246ca724 100644 --- a/r-package/R/zzzz.R +++ b/r-package/R/zzzz.R @@ -21,7 +21,7 @@ cli::cli_li( c( "Website: https://basedosdados.org/", - "Docs: https://basedosdados.github.io/mais/")), + "Docs: https://basedosdados.github.io/sdk/")), cli::cli_end(), diff --git a/stata-package/Minitutorial.md b/stata-package/Minitutorial.md index 9d639e0da..29e707b37 100644 --- a/stata-package/Minitutorial.md +++ b/stata-package/Minitutorial.md @@ -26,6 +26,6 @@ __Passo 2.__ Após instalar o Python, abra o menu iniciar, digite "cmd" e abra. __Passo 3.__ Após concluir a instalação do pacote basedosdados, digite `basedosdados reauth` no Prompt de Comando. Copie o link que aparecerá, cole na sua aba de navegação e dê autorização ao google. Em seguida, copie o código gerado, volte e cole na tela do Prompt e dê enter. -> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/mais/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). +> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/sdk/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). Após finalizar esses 3 passos, já será possível abrir o Stata e começar a usar o pacote. Para saber mais sobre os comandos do pacote, leia esse manual [aqui](https://github.com/basedosdados/mais/tree/master/stata-package). diff --git a/stata-package/README.md b/stata-package/README.md index 3740b181e..9b1ca87ee 100644 --- a/stata-package/README.md +++ b/stata-package/README.md @@ -19,7 +19,7 @@ A instalação do pacote `basedosdados` no Stata consiste basicamente na execuç 1. Garantir que seu Stata seja a __versão 16+__ 2. Garantir que o Python esteja instalado no seu computador - você pode se guiar pelo nosso Mini Tutorial de Python [aqui](https://github.com/basedosdados/mais/blob/master/stata-package/Minitutorial.md). Nesse tutorial você também vai descobrir como autenticar seu projeto pelo prompt do seu computador (__importante!__). -> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/mais/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). +> Caso esteja utilizando os dados da BD pela primeira vez, é necessário criar um projeto para que você possa fazer as queries no nosso repositório. Ter um projeto é de graça e basta ter uma conta Google (seu gmail por exemplo). [Veja aqui como criar um projeto no Google Cloud](https://basedosdados.github.io/sdk/access_data_bq/#antes-de-comecar-crie-o-seu-projeto-no-google-cloud). Após garantir esses dois requerimentos __obrigatórios__, você pode finalmente instalar o pacote digitando o seguinte comando no seu Stata: