Skip to main content

IDS data model extension for CKAN

Project description

Tests

ckanext-ids

TODO: Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!

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 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-ids:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/semantic-web-company/ckanext-ids.git cd ckanext-ids pip install -e . pip install -r requirements.txt

  3. Add ids and ids_dummy to the ckan.pluginssetting in your CKAN config file (by default the config file is located at/etc/ckan/default/ckan.ini`).

  4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

# The URL of the local dataspace connector
ckanext.ids.trusts_local_dataspace_connector_url = http://localhost:8089
# The username of the local dataspace connector
ckanext.ids.trusts_local_dataspace_connector_username = admin
# The password of the local dataspace connector
ckanext.ids.trusts_local_dataspace_connector_password = password

Developer installation

To install ckanext-ids for development, activate your CKAN virtualenv and do:

git clone https://github.com/semantic-web-company/ckanext-ids.git
cd ckanext-ids
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-ids

If ckanext-ids should be available on PyPI you can follow these steps to publish a new version:

  1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

  2. Make sure you have the latest version of necessary packages:

    pip install --upgrade setuptools wheel twine

  3. Create a source and binary distributions of the new version:

    python setup.py sdist bdist_wheel && twine check dist/*
    

    Fix any errors you get.

  4. Upload the source distribution to PyPI:

     twine upload dist/*
    
  5. Commit any outstanding changes:

    git commit -a
    git push
    
  6. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

    git tag 0.0.1
    git push --tags
    

License

AGPL

Funding

This code was created as part of project TRUSTS: Trusted secure data sharing space.

This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 871481.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-ids-1.0.13.tar.gz (110.9 kB view details)

Uploaded Source

Built Distribution

ckanext_ids-1.0.13-py3-none-any.whl (134.3 kB view details)

Uploaded Python 3

File details

Details for the file ckanext-ids-1.0.13.tar.gz.

File metadata

  • Download URL: ckanext-ids-1.0.13.tar.gz
  • Upload date:
  • Size: 110.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for ckanext-ids-1.0.13.tar.gz
Algorithm Hash digest
SHA256 cb0b7f502c8f73acfb218fb1690bd7aafb16c4202a57fde2f3f2c9cdf61be6e5
MD5 a354d57f87f2df5cefd5dcdfd718b9eb
BLAKE2b-256 3ea8b8fef3e97db8f75d4d3db85392a8f14df1be6eb234db3779bc4a138acf30

See more details on using hashes here.

File details

Details for the file ckanext_ids-1.0.13-py3-none-any.whl.

File metadata

  • Download URL: ckanext_ids-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 134.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for ckanext_ids-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 5069d6a39cb0af5df6c4e072475b78dbeb93bafcf98ea8a8797aaaaec9b04189
MD5 e4b7ba9fcd03b31aa4f4213613df1761
BLAKE2b-256 18c77223db42cdbcb167be80a115fb458a09d8259318a05fbace93335039fa04

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page