Bem Vindo à documentação dpckan

Criar conjunto de dados

create_dataset.create(ckan_host, ckan_key, datapackage)

Função responsável pela publicação de um conjunto de dados na instância CKAN desejada.

Parâmetros:

ckan_host: string

host ou ambiente da instância CKAN para a qual se deseja publicar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string

Chave CKAN do usuário e ambiente para a qual se deseja publicar conjunto de dados.

datapackage: string

Caminho local para arquivo datapackage.json.

Retorna:

Conjunto de dados publicado no ambiente desejado.

create_dataset.create_cli(ckan_host, ckan_key, datapackage)

Função CLI responsável pela publicação de um conjunto de dados na instância CKAN desejada.

Por padrão, função buscará host e key da instância CKAN nas variáveis de ambiente CKAN_HOST e CKAN_KEY cadastradas na máquina ou em arquivo .env na raiz do dataset.

Parâmetros:

ckan_host: string (não obrigatório caso variável CKAN_HOST esteja cadastrada na máquina ou em arquivo .env)

host ou ambiente da instância CKAN para a qual se deseja publicar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string (não obrigatório caso variável CKAN_KEY esteja cadastrada na máquina ou em arquivo .env)

Chave CKAN do usuário e ambiente para a qual se deseja publicar conjunto de dados.

datapackage: string (não obrigatório caso comando seja executado no mesmo diretório do arquivo datapackage.json)

Caminho local para arquivo datapackage.json.

Retorna:

Conjunto de dados publicado no ambiente desejado.

Atualizar conjunto de dados

update_dataset.update(ckan_host, ckan_key, datapackage)

Função responsável pela atualização de um conjunto de dados na instância CKAN desejada.

Parâmetros:

ckan_host: string

host ou ambiente da instância CKAN para a qual se deseja atualizar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string

Chave CKAN do usuário e ambiente para a qual se deseja atualizar conjunto de dados.

datapackage: string

Caminho local para arquivo datapackage.json.

Retorna:

Conjunto de dados atualizado no ambiente desejado.

update_dataset.update_cli(ckan_host, ckan_key, datapackage)

Função CLI responsável pela atualização de um conjunto de dados na instância CKAN desejada.

Por padrão, função buscará host e key da instância CKAN nas variáveis de ambiente CKAN_HOST e CKAN_KEY cadastradas na máquina ou em arquivo .env na raiz do dataset.

Parâmetros:

ckan_host: string (não obrigatório caso variável CKAN_HOST esteja cadastrada na máquina ou em arquivo .env)

host ou ambiente da instância CKAN para a qual se deseja atualizar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string (não obrigatório caso variável CKAN_KEY esteja cadastrada na máquina ou em arquivo .env)

Chave CKAN do usuário e ambiente para a qual se deseja atualizar conjunto de dados.

atapackage: string (não obrigatório caso comando seja executado no mesmo diretório do arquivo datapackage.json)

Caminho local para arquivo datapackage.json.

Retorna:

Conjunto de dados atualizado no ambiente desejado.

Criar recurso

create_resource.create_resource(ckan_host, ckan_key, datapackage, resource_name)

Função responsável pela publicação de um recurso em conjunto de dados já existente na instância CKAN desejada.

Parâmetros:

ckan_host: string

host ou ambiente da instância CKAN para a qual se deseja publicar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string

Chave CKAN do usuário e ambiente para a qual se deseja publicar conjunto de dados.

datapackage: string

Caminho local para arquivo datapackage.json.

resource_name: string

Nome do recurso, presente no arquivo datapackage.json, que será criado.

Retorna

Recurso criado em um conjunto de dados previamente publicado no ambiente desejado.

create_resource.create_resource_cli(ckan_host, ckan_key, datapackage, resource_name)

Função CLI responsável pela publicação de um recurso em conjunto de dados já existente na instância CKAN desejada.

Por padrão, função buscará host e key da instância CKAN nas variáveis de ambiente CKAN_HOST e CKAN_KEY cadastradas na máquina ou em arquivo .env na raiz do dataset.

Parâmetros:

ckan_host: string (não obrigatório caso variável CKAN_HOST esteja cadastrada na máquina ou em arquivo .env)

host ou ambiente da instância CKAN para a qual se deseja publicar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string (não obrigatório caso variável CKAN_KEY esteja cadastrada na máquina ou em arquivo .env)

Chave CKAN do usuário e ambiente para a qual se deseja publicar conjunto de dados.

datapackage: string (não obrigatório caso comando seja executado no mesmo diretório do arquivo datapackage.json)

Caminho local para arquivo datapackage.json.

resource_name: string

Nome do recurso, presente no arquivo datapackage.json, que será criado.

Retorna:

Recurso criado em um conjunto de dados previamente publicado no ambiente desejado.

Atualizar recurso

update_resource.update_resource(ckan_host, ckan_key, datapackage, resource_id, resource_name)

Função responsável pela atualização de um recurso em conjunto de dados já existente na instância CKAN desejada.

Parâmetros:

ckan_host: string

host ou ambiente da instância CKAN para a qual se deseja atualizar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string

Chave CKAN do usuário e ambiente para a qual se deseja atualizar conjunto de dados.

datapackage: string

Caminho local para arquivo datapackage.json.

resource_name: string

Nome do recurso, presente no arquivo datapackage.json, que será atualizado.

Retorna:

Recurso atualizado em um conjunto de dados previamente publicado no ambiente desejado.

update_resource.update_resource_cli(ckan_host, ckan_key, datapackage, resource_id, resource_name)

Função CLI responsável pela atualização de um recurso em conjunto de dados já existente na instância CKAN desejada.

Por padrão, função buscará host e key da instância CKAN nas variáveis de ambiente CKAN_HOST e CKAN_KEY cadastradas na máquina ou em arquivo .env na raiz do dataset.

Parâmetros:

ckan_host: string (não obrigatório caso variável CKAN_HOST esteja cadastrada na máquina ou em arquivo .env)

host ou ambiente da instância CKAN para a qual se deseja publicar conjunto de dados. Exemplo: https://demo.ckan.org/

ckan_key: string (não obrigatório caso variável CKAN_KEY esteja cadastrada na máquina ou em arquivo .env)

Chave CKAN do usuário e ambiente para a qual se deseja publicar conjunto de dados.

datapackage: string (não obrigatório caso comando seja executado no mesmo diretório do arquivo datapackage.json)

Caminho local para arquivo datapackage.json.

resource_id: string

Id do recurso, presente no arquivo datapackage.json, que ser atualizado.

resource_name: string

Nome do recurso, presente no arquivo datapackage.json, que será atualizado.

Retorna:

Recurso atualizado em um conjunto de dados previamente publicado no ambiente desejado.