Federación¶

Extensión de pydatajson para la federación de metadatos de datasets a través de la API de CKAN.

pydatajson.federation.harvest_catalog_to_ckan(catalog, portal_url, apikey, catalog_id, dataset_list=None, owner_org=None)[fuente]¶

Federa los datasets de un catálogo al portal pasado por parámetro.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que se federa. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset. catalog_id (str) – El prefijo con el que va a preceder el id del dataset en catálogo destino. dataset_list (list(str)) – Los ids de los datasets a federar. Si no se pasa una lista, todos los datasests se federan. owner_org (str) – La organización a la cual pertencen los datasets. Si no se pasa, se utiliza el catalog_id.
Devuelve:	El id del dataset en el catálogo de destino.
	str

pydatajson.federation.harvest_dataset_to_ckan(catalog, owner_org, dataset_origin_identifier, portal_url, apikey, catalog_id)[fuente]¶

Federa la metadata de un dataset en el portal pasado por parámetro.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que contiene el dataset. owner_org (str) – La organización a la cual pertence el dataset. dataset_origin_identifier (str) – El id del dataset que se va a restaurar. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset. catalog_id (str) – El id que prep
Devuelve:	El id del dataset restaurado.
	str

pydatajson.federation.push_dataset_to_ckan(catalog, owner_org, dataset_origin_identifier, portal_url, apikey, catalog_id=None, demote_superThemes=True, demote_themes=True)[fuente]¶

Escribe la metadata de un dataset en el portal pasado por parámetro.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que contiene el dataset. owner_org (str) – La organización a la cual pertence el dataset. dataset_origin_identifier (str) – El id del dataset que se va a federar. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset. catalog_id (str) – El prefijo con el que va a preceder el id del dataset en catálogo destino. demote_superThemes (bool) – Si está en true, los ids de los super themes del dataset, se propagan como grupo. demote_themes (bool) – Si está en true, los labels de los themes del dataset, pasan a ser tags. Sino, se pasan como grupo.
Devuelve:	El id del dataset en el catálogo de destino.
	str

pydatajson.federation.push_new_themes(catalog, portal_url, apikey)[fuente]¶

Toma un catálogo y escribe los temas de la taxonomía que no están presentes.

Args:

catalog (DataJson): El catálogo de origen que contiene la

taxonomía.

portal_url (str): La URL del portal CKAN de destino. apikey (str): La apikey de un usuario con los permisos que le

permitan crear o actualizar el dataset.

Returns:

str: Los ids de los temas creados.

pydatajson.federation.push_theme_to_ckan(catalog, portal_url, apikey, identifier=None, label=None)[fuente]¶

Escribe la metadata de un theme en el portal pasado por parámetro.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que contiene el theme. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset. identifier (str) – El identificador para buscar el theme en la taxonomia. label (str) – El label para buscar el theme en la taxonomia.
Devuelve:	El name del theme en el catálogo de destino.
	str

pydatajson.federation.remove_datasets_from_ckan(portal_url, apikey, filter_in=None, filter_out=None, only_time_series=False, organization=None)[fuente]¶

Borra un dataset en el portal pasado por parámetro.

Parámetros:

portal_url (str) – La URL del portal CKAN de destino.
apikey (str) – La apikey de un usuario con los permisos que le permitan borrar el dataset.
filter_in (dict) – Diccionario de filtrado positivo, similar al de search.get_datasets.
filter_out (dict) – Diccionario de filtrado negativo, similar al de search.get_datasets.
only_time_series (bool) – Filtrar solo los datasets que tengan recursos con series de tiempo.
organization (str) – Filtrar solo los datasets que pertenezcan a cierta organizacion.

Devuelve:

None

pydatajson.federation.restore_catalog_to_ckan(catalog, owner_org, portal_url, apikey, dataset_list=None)[fuente]¶

Restaura los datasets de un catálogo al portal pasado por parámetro. Si hay temas presentes en el DataJson que no están en el portal de CKAN, los genera.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que se restaura. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset. dataset_list (list(str)) – Los ids de los datasets a restaurar. Si no se pasa una lista, todos los datasests se restauran. owner_org (str) – La organización a la cual pertencen los datasets. Si no se pasa, se utiliza el catalog_id.
Devuelve:	El id del dataset en el catálogo de destino.
	str

pydatajson.federation.restore_dataset_to_ckan(catalog, owner_org, dataset_origin_identifier, portal_url, apikey)[fuente]¶

Restaura la metadata de un dataset en el portal pasado por parámetro.

Tipo del valor devuelto:
Parámetros:	catalog (DataJson) – El catálogo de origen que contiene el dataset. owner_org (str) – La organización a la cual pertence el dataset. dataset_origin_identifier (str) – El id del dataset que se va a restaurar. portal_url (str) – La URL del portal CKAN de destino. apikey (str) – La apikey de un usuario con los permisos que le permitan crear o actualizar el dataset.
Devuelve:	El id del dataset restaurado.
	str