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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf03f7ceca607acb73978abf6e72d083b67384a9fe3bda652869b4f4b83fcfb0 |
|
MD5 | ea519431f62e21a9fd284199d5da0b74 |
|
BLAKE2b-256 | 019577d64ce379c13b521e317b96b8216382384321a02908e54524a38fa9af4a |
Hashes for ckanext_Dataset_Reference-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd6db6db170ba70721f85420d541be9bc0e585a4b34e2ed33760ab4a1592efc0 |
|
MD5 | b889a351ab64231216fe89dee5ea05fb |
|
BLAKE2b-256 | 7f6cee1e202a882ca17aadf082a56739f3808793edf6295eb0bf0b9057ef3b5f |