Skip to content

Commit

Permalink
Resolve ofek#29 e ofek#23. Atualizando o README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarofpp committed Aug 6, 2019
1 parent 103d237 commit ad86b39
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,39 @@

Pacote para baixar os dados do portal de [dados abertos da UFRN](dados.ufrn.br).

## Instalação
```bash
pip install odufrn-downloader
```

## Utilizando
## Guia de uso
Veja a documentação [clicando aqui](https://odufrn.github.io/odufrn-downloader/).

Como começar a usar o pacote:
```python
from odufrn_downloader import ODUFRNDownloader
ufrn_data = ODUFRNDownloader()
```

### Métodos
Abaixo estão listados os métodos disponíveis no pacote:

| Método | Descrição |
| ------ | ------- |
| `download_all` | Baixa todos os conjuntos de dados disponíveis. |
| `download_dataset` | Baixa o conjunto de dados desejado. |
| `download_datasets` | Baixa uma lista de conjuntos de dados desejado. |
| `download_from_file` | Baixa os conjuntos de dados que estão escritos em um arquivo de texto. |
| `download_group` | Baixa um grupo de conjuntos de dados desejado. |
| `download_groups` | Baixa uma lista de grupos de conjuntos de dados desejado. |
| `load_datasets` | Atualiza a lista de datasets disponíveis. |
| `load_groups` | Atualiza a lista de grupos disponíveis. |
| `list_datasets` | Lista os conjuntos de dados. |
| `list_groups` | Lista os grupos de conjuntos de dados. |
| `search_related_datasets` | Retorna uma lista de conjuntos de dados relacionados a uma entrada. |
| `search_related_groups` | Retorna uma lista de grupos de conjuntos de dados relacionados a uma entrada. |

### Exemplo
```python
from odufrn_downloader import ODUFRNDownloader
ufrn_data = ODUFRNDownloader()
Expand All @@ -25,5 +52,5 @@ ufrn_data.download_datasets(datasets)
```

----------------
Projeto idealizado por [Ítalo Epifânio](https://github.com/itepifanio).
Projeto inicialmente idealizado por [Ítalo Epifânio](https://github.com/itepifanio).
Link do projeto original [aqui](https://github.com/professorCheatSheet/dadosAbertosUFRNDownloader).

0 comments on commit ad86b39

Please sign in to comment.