No project description provided
Project description
ckanext-relationship
The extension adds an additional table to the database that stores relationships between entities in the form of triples (subject_id, object_id, relation_type). The relation_type parameter sets the type of relationship: peer-to-peer (related_to <=> related_to) and subordinate (child_of <=> parent_of). Adding, deleting and getting a list of relationships between entities is carried out using actions (relation_create, relation_delete, relations_list). The description of the types of relationships between entities is carried out in the entity schema in the form:
- field_name: related_projects
label: Related Projects
preset: related_entity
current_entity: package
current_entity_type: dataset
related_entity: package
related_entity_type: project
relation_type: related_to
multiple: true
updatable_only: false
required: false
Entity (current_entity, related_entity) - one of three options: package, organization, group.
Entity type (current_entity_type, related_entity_type) - entity customized using ckanext-scheming.
Multiple - toggle the ability to add multiple related entities.
Updatable_only - toggle the ability to add only entities that can be updated by the current user.
Requirements
TODO: For example, you might want to mention here which versions of CKAN this extension works with.
If your extension works across different versions you can add the following table:
Compatibility with core CKAN versions:
CKAN version | Compatible? |
---|---|
2.6 and earlier | not tested |
2.7 | not tested |
2.8 | not tested |
2.9 | not tested |
Suggested values:
- "yes"
- "not tested" - I can't think of a reason why it wouldn't work
- "not yet" - there is an intention to get it working
- "no"
Installation
TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.
To install ckanext-relationship:
-
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
-
Clone the source and install it on the virtualenv
git clone https://github.com//ckanext-relationship.git cd ckanext-relationship pip install -e . pip install -r requirements.txt
-
Add
relationship
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/ckan.ini
). -
Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Config settings
None at present
TODO: Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.relationship.some_setting = some_default_value
Developer installation
To install ckanext-relationship for development, activate your CKAN virtualenv and do:
git clone https://github.com//ckanext-relationship.git
cd ckanext-relationship
python setup.py develop
pip install -r dev-requirements.txt
Tests
To run the tests, do:
pytest --ckan-ini=test.ini
Releasing a new version of ckanext-relationship
If ckanext-relationship should be available on PyPI you can follow these steps to publish a new version:
-
Update the version number in the
setup.py
file. See PEP 440 for how to choose version numbers. -
Make sure you have the latest version of necessary packages:
pip install --upgrade setuptools wheel twine
-
Create a source and binary distributions of the new version:
python setup.py sdist bdist_wheel && twine check dist/*
Fix any errors you get.
-
Upload the source distribution to PyPI:
twine upload dist/*
-
Commit any outstanding changes:
git commit -a git push
-
Tag the new release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.1 then do:git tag 0.0.1 git push --tags
License
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-relationship-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38824de7bd88eb2aa35a50f67b17aa3cc9ac7472f815300f5018bfed1d276df9 |
|
MD5 | 5c22ad4f86e3b0f312770b1085ccc5fe |
|
BLAKE2b-256 | 5de0fedee06b454b02928bc3abbfa01c4b490241c8b6cd8d0e7e249f0259fde6 |
Hashes for ckanext_relationship-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2b7eb4294accbd6aeb25e4da3e2a8d3e030bd44cb74aaabee1ed227d3547a2c |
|
MD5 | 75cebfbe25a4ff244c6c6eb4398352b1 |
|
BLAKE2b-256 | 1fea7d3bed062561d05cb198340593ef1289a9efefc4edac04aab1ecc83a8afc |