odufrn / odufrn-downloader

Pacote para baixar os dados do portal de dados abertos da UFRN
https://odufrn.github.io/odufrn-downloader/
MIT License
32 stars 4 forks source link

Relacionamento/Fluxo entre Package e Group #84

Open alvarofpp opened 5 years ago

alvarofpp commented 5 years ago

Definir um tipo de relacionamento/fluxo entre Package e Group

Criar um fluxo entre as classes Package e Group, que facilite o fluxo do desenvolvedor durante a etapa de exploração.

Checklist:

Para entender melhor

Tomemos como exemplo a requisição http://dados.ufrn.br/api/rest/dataset/discentes. Existem um atributo que podemos usar na requisição de package: groups (um array com os grupos a qual o pacote pertence). Por exemplo, poderia ser criado algum método que permitisse eu sair do pacote discentes e chegar ao grupo ensino, visto que o pacote discentes pertence a esse grupo.

Exemplo

# Package de discentes
package_discentes

# Lista dos grupos ao qual pertence
discentes_groups = package_discentes.groups  # ['ensino', 'pessoas']

# Quantidade de grupos que pertence
len(package_discentes.groups)  # 2

# Chegar ao grupo de ensino MODO 1
group_ensino = package_discentes.get_group(0)

# Chegar ao grupo de ensino MODO 2
group_ensino = package_discentes.get_group('ensino')
group_ensino = package_discentes.get_group(discentes_groups[0])

Observações: verificar se o pacote pertence ao grupo desejado.

alvarofpp commented 5 years ago

Pensando bem, como group_ensino = package_discentes.get_group(0) pode gerar confusão, pois alguns podem pensar que começa do 1 e não do 0, creio que seria melhor apenas passando uma string, como é o caso do segundo modo.