Skip to content

Commit

Permalink
[#15] melhorando readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielbdornas committed Jun 10, 2021
1 parent ecadcc2 commit 443f228
Showing 1 changed file with 19 additions and 33 deletions.
52 changes: 19 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DPKG CKAN MG
# Dados MG

## Descrição

Expand All @@ -11,66 +11,52 @@ Obs.: "#" Utlizados nas caixas de código abaixo são comentários e deverão se
- Instalação

```
$ pip install dpkgckanmg
$ pip install dadosmg
```

- Trabalhando com variáveis de ambiente

A utilizaçao deste pacote exige a utilizaçao de chaves CKAN, tanto do ambiente de [homologação](https://homologa.cge.mg.gov.br/) quanto de [produção](https://dados.mg.gov.br/). Para solicitar login de acesso mande um e-mail para dadosabertos@cge.mg.gov.br.


Sugerimos a criação de um arquivo .env na raiz do pacote (bem como o cadastro .gitignore do mesmo) para utilização destas chaves sem a sincronização das mesmas com o repositório online. O pacote "python-dotenv" necessário para carregamento das chaves cadastradas no arquivo .env, será instalado juntamente com o pacote. Sendo assim, sugerimos os seguintes passos para criaçao do arquivo .env:
Crie um arquivo .env na raiz do Dataset/Conjunto de dados (bem como o cadastro .gitignore do mesmo) para utilização destas chaves sem a sincronização das mesmas com o repositórios online. O pacote "python-dotenv" necessário para carregamento das chaves cadastradas no arquivo .env, será instalado juntamente com o pacote. Sendo assim, sugerimos os seguintes passos para criaçao do arquivo .env:

```
# Criação arquivo .env com estrutura para receber chaves CKAN homologação e produção
# Após a criação, abra o arquivo e inclua as chaves em seus respectivos ambientes
$ echo "CKAN_HOMOLOGA=''\nCKAN_PORTAL=''" > .env
$ echo "CKAN_KEY_HOMOLOGACAO_ENV=''\nCKAN_KEY_PRODUCAO_ENV=''" > .env
# Inclua ".env" na última linha do arquivo .gitignore existente na raiz do conjunto. Caso .gitignore não exista execute o comando abaixo:
# CUIDADO: Caso comando abaixo seja executado em um conjunto cujo .gitignore exista toda configuração preexistente no mesmo será apagada
$ echo ".env" > .gitignore
```

## cli
```Terminal
# publicação em ambiente de homologação (atalho para "dadosmg -e homologacao")
$ dadosmg
- Publicação de conjuntos (Arquivo Python ou terminal)
- publish(package_path, ckan_key, environment):
- package_path: caminho do arquivo datapackage.json
- ckan_key: chave ckan do usuário no ambiente desejado
- environment: escolher entre "homologa" e"portal" (homologa default)

# publicação em ambiente de produção
$ dadosmg -e producao
```
# Publicação em ambiente de homologação - Executar na raiz do conjunto (local onde datapackage.json está armazenado)

import os
from dotenv import load_dotenv
load_dotenv()
from dpkgckanmg import publish
publish("./", os.getenv('CKAN_HOMOLOGA'), "homologa")

## Arquivo Python ou terminal Python

# Publicação em ambiente de produção - Executar na raiz do conjunto (local onde datapackage.json está armazenado)
- publish(environment="homologacao"):
- environment: escolher entre "homologacao" e"producao" (homologacao default)

import os
from dotenv import load_dotenv
load_dotenv()
from dpkgckanmg import publish
publish("./", os.getenv('CKAN_PORTAL'), "portal")
```
# Publicação em ambiente de homologação - Executar na raiz do conjunto (local onde datapackage.json está armazenado)
# Criar Recurso
from dpkgckanmg import criarArquivo2
criarArquivo2(1, 2, 3)

# Atualizar Data Set
from dpkgckanmg import dataSet
dataSet(1, 2, 3)
from dadosmg import publish
publish("homologa")
# Atualizar Recurso
from dpkgckanmg import resource
resource(1, 2, 3)
# Publicação em ambiente de produção - Executar na raiz do conjunto (local onde datapackage.json está armazenado)
### 1,2 3 deveráo ser retirados do arquivo .doc (gabriel atualizará)
from dadosmg import publish
publish("producao")
```

## Desenvolvimento
Expand Down

0 comments on commit 443f228

Please sign in to comment.