Commit eae297e3 authored by Denis Laxalde's avatar Denis Laxalde
Browse files

[doc] Update README

parent d7f97a999d12
......@@ -6,18 +6,16 @@ This cube enables data publishing to a CKAN opendata portal.
Configuration
-------------
The cube essentially provides an adapter ``ICKANPublishable`` which relies on
a ``ckan_dataset_id`` attribute on the adapted entity. As its name suggests,
the latter is used to relate a CubicWeb entity to a CKAN dataset (the
fundamental entity type in CKAN data model). Most of the synchronization to
the CKAN instance is done in hooks so usually one would set tight security
rules for this attribute, e.g.:
::
The cube essentially provides hooks to push data in a CKAN instance. The
mapping from CubicWeb entities is handled by adapters which themselves rely on
dedicated attributes on the entities:
class MyEntity(EntityType):
ckan_dataset_id = String(
description=_('identifier of corresponding CKAN dataset'),
__permissions__={'read': ('managers', 'users', 'guests'),
'add': (),
'update': ()},
)
* ``ICKANDataset`` adapter relies on a ``ckan_dataset_id`` attribute on the
adapted entity. As its name suggests, the latter is used to relate a
CubicWeb entity to a CKAN dataset (the fundamental entity type in CKAN
data model).
* ``ICKANResource`` adapter relies on a ``ckan_resource_id`` attribute. It
is used to related some CubicWeb entity type to a CKAN resource.
See ``test/data`` for a minimal example.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment