This CKAN extension ables CKAN users to link references to their dataset. A reference can be a publication or another dataset. The extension embeds the added references to the target dataset view as a table of citations.
Project description
ckanext-Dataset-Reference
This CKAN extension ables CKAN users to link references to their dataset. A reference can be a publication or another dataset. The extension embeds the added references to the target dataset view as a table of citations.
There are three ways to add a reference:
- With the DOI number or link (look at http://dx.doi.org/)
- With pasting the BibTex (http://www.bibtex.org/) citation metadata (Not implemented yet)
- Manually adding the target reference metadata. (Not implemented yet)
Requirements
Compatibility with core CKAN versions:
CKAN version | Compatible? |
---|---|
2.9 | Yes |
earlier | No |
Installation
To install ckanext-Dataset-Reference:
-
Activate your CKAN virtual environment, for example:
> source /usr/lib/ckan/default/bin/activate > pip install ckanext-Dataset-Reference
OR, Clone the source and install it on the virtualenv (Suggested location: /usr/lib/ckan/default/src) :
git clone https://github.com/TIBHannover/ckanext-Dataset-Reference.git
cd ckanext-Dataset-Reference
pip install -e .
pip install -r requirements.txt
-
Add
dataset_reference
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/ckan.ini
). -
Upgrade the CKAN database to add the plugin table:
ckan -c /etc/ckan/default/ckan.ini db upgrade -p dataset_reference
-
Restart CKAN and supervisor. For example if you've deployed CKAN with nginx on Ubuntu:
sudo service nginx reload sudo service supervisor reload
Tests
To run the tests, do:
pytest --ckan-ini=test.ini --disable-pytest-warnings ckanext/dataset_reference/tests/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ckanext-Dataset-Reference-2.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a740ff7ce547f9e3cd5a5a68d9600fe1f7913f4949b0346ab461fcfd47ed483f |
|
MD5 | 6bf50060e25a18dd7f38d492df9256de |
|
BLAKE2b-256 | dd2c3b8ca6cc896c074b95a4b365b0f5d4a23d0c30ddd2cc951808a183b71196 |
Hashes for ckanext_Dataset_Reference-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bf6ae1b7eba5cb6a09f5083cf3fa577b4d6c5939eab35c59c652737fe3c5251 |
|
MD5 | 18726ca0f373d4cb17691023f489aa55 |
|
BLAKE2b-256 | f454de08e34b6a868b5e49fef5cc9e05b1fa3215333216388863b81f29c295b3 |