Extension Experience


Extension Basics

Title
Experience
Name
ckanext-experience
Type
Public extension
Description
Create Experiences in CKAN based on ckanext-showcase, allowing users to showcase and link datasets used in apps, websites, visualizations, articles, reports or blog posts.
CKAN versions
Download-Url (zip)
Last commit
4 years ago (2021-04-01 17:24:30)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

ckanext-experience

Experience and link to datasets in use. Datasets used in an app, website or visualization, or featured in an article, report or blog post can be showcased within the CKAN website.

Experiences can include: - Image - Description - Tags - External link - Multiple related datasets

Experiences help users discover related datasets being used together. They can be discovered by searching and filtered by tag.

Site sysadmins can promote selected users to become ‘Experience Admins’ to help create, populate and maintain experiences.

ckanext-experience is intended to be a more powerful replacement for the ‘Related Item’ feature.

Requirements

Compatible with CKAN 2.3+.

N.B. The migrate command requires the Related Item models and actions, which have been removed in CKAN 2.6. If you wish to migrate your Related Items, please first upgrade CKAN to 2.5, do the migration, then continue upgrading to CKAN 2.6+.

Installation

To install ckanext-experience:

  1. Activate your CKAN virtual environment:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-experience Python package:

    pip install ckanext-experience
    
  3. Add experience to the ckan.plugins setting in your CKAN config file.

  4. Restart CKAN.

API

All actions are available via CKAN Action API:

Experience Actions

  • ckanext_showcase_create - Create new experience (sysadmins and experience admins)
  • ckanext_showcase_delete - Delete experience
  • ckanext_showcase_show - Show experience details
  • ckanext_showcase_list - List all experiences

Dataset Actions

  • ckanext_showcase_package_association_create - Add dataset to experience
  • ckanext_showcase_package_association_delete - Remove dataset from experience
  • ckanext_showcase_package_list - List datasets in experience
  • ckanext_package_showcase_list - List experiences featuring a dataset

Admin Actions

  • ckanext_showcase_admin_add - Add experience admin
  • ckanext_showcase_admin_remove - Remove experience admin
  • ckanext_showcase_admin_list - List experience admins

Migrating from Related Items

Use the experience migrate command to create Experiences from Related Items:

paster experience migrate -c {path to production.ini}

License

AGPL-3.0 license

Version
1.0.0
Version release date
2021-11-26
Contact name
Keitaro Inc
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘experience’ to ckan.plugins. Based on ckanext-showcase with similar API. For migration from Related Items, upgrade to CKAN 2.5 first before migrating.

Plugins to configure (ckan.ini)
experience
CKAN Settings (ckan.ini)
# No specific configuration options documented
DB migration to be executed
(not set)
<< back to Extensions