Skip to content

Commit

Permalink
adjust docs: mais to sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
rdahis committed Nov 12, 2024
1 parent 17f677e commit dd37b9d
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 30 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ 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 :)

## 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
8 changes: 2 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
# OLD repo name
.bases
.mais
.sdk
bases/pytest/*
bases/test/
pytest/*
test/*
test.py


.DS_Storage
*/*/.DS_Storage


# NEW repo name
.mais
mais/pytest/*
mais/test/

bases/*/input/
bases/*/tmp/
bases/*/output/
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand All @@ -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":

<p align="left">
<a href="https://github.com/basedosdados/mais/blob/master/stata-package/blob/main/examples/python1.png">
<img src="stata-package/examples/python1.png" width="400" alt="Base dos Dados Mais">
<a href="https://github.com/basedosdados/sdk/blob/master/stata-package/blob/main/examples/python1.png">
<img src="stata-package/examples/python1.png" width="400" alt="Base dos Dados">
</a>
</p>

__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.

<p align="left">
<a href="https://github.com/basedosdados/mais/blob/master/stata-package/blob/main/examples/prompt.png">
<img src="stata-package/examples/prompt.png" width="400" alt="Base dos Dados Mais">
<a href="https://github.com/basedosdados/sdk/blob/master/stata-package/blob/main/examples/prompt.png">
<img src="stata-package/examples/prompt.png" width="400" alt="Base dos Dados">
</a>
</p>

__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.

> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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).
> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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..
2 changes: 1 addition & 1 deletion docs/docs/pt/access_data_bq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion r-package/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Authors@R:
role = c("aut"),
email = "[email protected]",
comment = c(ORCID = "0000-0003-3709-4760")))
Description: An R interface to the 'Base dos Dados' API <https://basedosdados.github.io/mais/py_reference_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 <https://basedosdados.github.io/sdk/py_reference_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)
Expand Down
2 changes: 1 addition & 1 deletion r-package/R/zzzz.R
Original file line number Diff line number Diff line change
Expand Up @@ -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(),

Expand Down
2 changes: 1 addition & 1 deletion stata-package/Minitutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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).
> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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).
2 changes: 1 addition & 1 deletion stata-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!__).

> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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).
> <img src="https://raw.githubusercontent.com/haghish/markdoc/master/Resources/images/attention.png" width="20px" height="20px" align="left" hspace="0" vspace="0"> 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:

Expand Down

0 comments on commit dd37b9d

Please sign in to comment.