Extension Ndpcatalogadditions


Extension Basics

Title
Ndpcatalogadditions
Name
ckanext-ndpcatalogadditions
Type
Public extension
Description
The **ndpcatalogadditions** extension for CKAN enhances data management workflows by providing spec
CKAN versions
Download-Url (zip)
Last commit
5 months ago (2025-08-15 21:26:16)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-ndpcatalogadditions

This CKAN plugin provides following endpoints to support NDP users submitting new datasets to Prekan, as well as modifying/deleting datasets that have already been submitted. Users must use a valid Keycloak token as a Bearer token to access these endpoints. Submitted datasets are not formally transferred to the NDP catalog until they have been reviewed.

For Users Submitting Datasets

  • POST /ndp/package_create

    Create a new dataset in Prekan by submitting a JSON string with the fields specified in this link: https://docs.ckan.org/en/2.10/api/#ckan.logic.action.create.package_create

  • POST /ndp/package_update

    Update a dataset in Prekan by submitting a JSON string with the fields specified in this link: https://docs.ckan.org/en/2.10/api/#ckan.logic.action.create.package_update

  • POST /ndp/package_delete

    Delete a dataset in Prekan by submitting a JSON string with the fields specified in this link: https://docs.ckan.org/en/2.10/api/#ckan.logic.action.create.package_delete

    Deleting a dataset does not physically remove the dataset entirely. The dataset is simply marked as deleted in Prekan so that it no longer appears in the list of datasets and in search results. To actually delete a dataset call package_purge as an administrator.

  • POST /ndp/package_purge

    Purge a dataset in Prekan by submitting a JSON string with the fields specified in this link: https://docs.ckan.org/en/2.10/api/#ckan.logic.action.delete.dataset_purge

    Please note that the admin privilege is required to invoke this endpoint.

  • GET/POST /ndp/my_package_list

    List all datasets submitted by the current user that have not yet been reviewed.

  • GET/POST /ndp/my_reviewed_package_list

    List all datasets submitted by the current user that have been reviewed.

This plugin creates a new Prekan account for the user, if the information in

Version
0.1.3
Version release date
2025-07-08
Contact name
NDP
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-ndpcatalogadditions:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/SDSC/ckanext-ndpcatalogadditions.git cd ckanext-ndpcatalogadditions pip install -e . pip install -r requirements.txt

  3. Add ndpcatalogadditions to the ckan.plugins setting in your CKAN config file (by default the config file is located at `/etc/ckan/de

Plugins to configure (ckan.ini)
ndpcatalogadditions
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions