ckanext-metadata_manager
The Metadata Manager allows exporting the metadata of datasets, resources, groups, and organizations to an Excel file and also importing them from an Excel file back into the website.
Additionally, an Excel list of all tags with their ID and name can be exported from the website into an Excel file.
Version information can be found in ./ckanext/metadata_manager/version.py
.
Requirements
Tested and developed for CKAN v2.10.1 and 2.11.2
Installation
Docker Installation
Clone the Git repo or add it directly as a submodule in the src
directory.
Cloning:
$ cd src/
$ git clone https://bitbucket.org/ondics/ckanext-metadata_manager.git
As a submodule:
$ git add submodule https://bitbucket.org/ondics/ckanext-metadata_manager.git ./src
Add the installation to the Dockerfile
(This step can be skipped if CKAN Docker is set up in development mode, using the ckan-dev
image, and the extension is placed in the ./src
directory)
COPY src/ $SRC_DIR
RUN cd $SRC_DIR/ckanext-metadata_manager && \
python3 setup.py develop
Add the extension to the plugin list in .env
:
CKAN__PLUGINS="... metadata_manager"
Build the container and restart CKAN:
$ docker compose -f docker-compose.dev.yml -p <parent-directory> build
$ docker compose -f docker-compose.dev.yml -p <parent-directory> up -d --remove-orphans
Source Installation
Get the sources:
$ cd /usr/lib/ckan/default/src
$ git clone https://bitbucket.org/ondics/ckanext-metadata_manager.git
Activate the CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
Install the extension in the virtual environment:
$ cd ckanext-metadata_manager
$ pip install .
Restart CKAN:
# If installed on the host
$ supervisorctl restart ckan-uwsgi
User Docs
In the website UI, there are docs for the export and import functions of this extension:
URL: /ckan-admin/metadata_manager/docs
The Import Metadata section in the User Docs now also includes an explanation of how to use the CKAN API.
Credits
Built with:
Author and License:
Not open source, all rights reserved
(C) 2024, Ondics GmbH