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
File details
Details for the file ckanext-Dataset-Reference-2.0.2.tar.gz
.
File metadata
- Download URL: ckanext-Dataset-Reference-2.0.2.tar.gz
- Upload date:
- Size: 24.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae32f1184e1c3c067f17a15f53e0d63eca3662541734518fc1a49a6c7b30838e |
|
MD5 | 528998d58a1119ca1065c98bfc7e6b84 |
|
BLAKE2b-256 | c48d2f18cdd1554b6ddd0ead14a31481fa11084b179704f1476fdf5faba44a8c |