ckanext-showcase

Showcase 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. Showcases can include an image, description, tags and external link. Showcases may contain several datasets, helping users discover related datasets being used together. Showcases can be discovered by searching and filtered by tag.

Site sysadmins can promote selected users to become 'Showcase Admins' to help create, populate and maintain showcases.

ckanext-showcase is intended to be a more powerful replacement for the 'Related Item' feature.

Requirements

Tested on CKAN 2.9 and 2.10.

Note: Use 1.5.2 for older CKAN versions (2.7 and 2.8).

Installation

To install ckanext-showcase:

Activate your CKAN virtual environment, for example:
```
. /usr/lib/ckan/default/bin/activate
```
Install the ckanext-showcase Python package into your virtual environment:
```
pip install ckanext-showcase
```
Add showcase to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
```
sudo service apache2 reload
```

Development Installation

To install ckanext-showcase for development, activate your CKAN virtualenv and do:

git clone https://github.com/ckan/ckanext-showcase.git
cd ckanext-showcase
pip install -e .
pip install -r dev-requirements.txt

The extension contains a custom build of CKEditor to allow using a WYSIWYG editor to write the content of the showcase. It has been built using webpack and the repository contains all the files needed to edit and customize it if needed:

npm install
npx webpack --config webpack.config.js

Build anatomy

assets/build/ckeditor.js - The ready-to-use editor bundle, containing the editor and all plugins.
assets/js/showcase-editor - The CKAN module that will load and config the bundle when using it as data-module attribute.
assets/src/ckeditor.js - The source entry point of the build. Based on it the build/ckeditor.js file is created by webpack. It defines the editor creator, the list of plugins and the default configuration of a build.
webpack.config.js - The webpack configuration used to build the editor.

More info on how to build CKEditor from source: https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start-other.html#building-the-editor-from-source

API

All actions in the Showcase extension are available in the CKAN Action API.

Showcase actions:

- create a new showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_create -H "Authorization:{YOUR-API-KEY}" -d '{"name": "my-new-showcase"}'

- delete a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_delete -H "Authorization:{YOUR-API-KEY}" -d '{"name": "my-new-showcase"}'

- show a showcase
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_show -d '{"id": "my-new-showcase"}'

- list showcases
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_list -d ''

Dataset actions:

- add a dataset to a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_create -H "Authorization:{YOUR-API-KEY}" -d '{"showcase_id": "my-showcase", "package_id": "my-package"}'

- remove a dataset from a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_delete -H "Authorization:{YOUR-API-KEY}" -d '{"showcase_id": "my-showcase", "package_id": "my-package"}'

- list datasets in a showcase
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_list -d '{"showcase_id": "my-showcase"}'

- list showcases featuring a given dataset
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_package_showcase_list -d '{"package_id": "my-package"}'

Showcase admin actions:

- add showcase admin (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_add -H "Authorization:{YOUR-API-KEY}" -d '{"username": "bert"}'

- remove showcase admin (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_remove -H "Authorization:{YOUR-API-KEY}" -d '{"username": "bert"}'

- list showcase admins (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_list -H "Authorization:{YOUR-API-KEY}" -d ''

UI

The Showcase extension adds the following pages to the user interface:

The main showcase index is available on: http://127.0.0.1:5000/showcase
To create a new showcase: http://127.0.0.1:5000/showcase/new
To edit or delete a showcase: http://127.0.0.1:5000/showcase/edit/{showcase-name}
To add a Showcase Admin : http://127.0.0.1:5000/ckan-admin/showcase_admins

Configuration

If you want to use the WYSIWYG editor instead of Markdown to write the content of the showcase:

ckanext.showcase.editor = ckeditor

Migrating Showcases Notes from Markdown to HTML

When using CKEditor as WYSIWYG editor showcases notes are stored in HTML instead of Markdown. To migrate all existing notes from markdown to HTML you can use the `showcase markdown_to_html` command.

From the ckanext-showcase directory:

ckan -c {path to production.ini} showcase markdown-to-html

Running the Tests

To run the tests, do:

pytest --ckan-ini=test.ini ckanext/showcase/tests

Registering ckanext-showcase on PyPI

ckanext-showcase should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-showcase. If that link doesn't work, then you can register the project on PyPI for the first time by following these steps:

Create a source distribution of the project:
```
python setup.py sdist
```
Register the project:
```
python setup.py register
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:
```
git tag 0.0.1
git push --tags
```

Releasing a New Version of ckanext-showcase

ckanext-showcase is availabe on PyPI as https://pypi.python.org/pypi/ckanext-showcase. To publish a new version to PyPI follow these steps:

Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
```
python setup.py sdist
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.2 then do:
```
git tag 0.0.2
git push --tags
```

i18n

See: "Internationalizing strings in extensions" : http://docs.ckan.org/en/latest/extensions/translating-extensions.html

Install babel

pip install Babel
Init Catalog for your language

python setup.py init_catalog -l es
Compile your language catalog ( You can force pybabel compile to compile messages marked as fuzzy with the -f)

python setup.py compile_catalog -f -l es

ziyunxiao / ckanext-showcase Goto Github PK