[![Tests](https://github.com/semantic-web-company/ckanext-ids/workflows/Tests/badge.svg?branch=main)](https://github.com/semantic-web-company/ckanext-ids/actions)
# 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.plugins` setting 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](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) 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](https://www.gnu.org/licenses/agpl-3.0.en.html)
## 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](https://cordis.europa.eu/project/id/871481).
Raw data
{
"_id": null,
"home_page": "https://github.com/semantic-web-company/ckanext-ids",
"name": "ckanext-ids",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "CKAN IDS",
"author": "Sotiris Karampatakis",
"author_email": "sotiris.karampatakis@semantic-web.com",
"download_url": "https://files.pythonhosted.org/packages/94/b3/d1d052aa5c866c56e1e9b881c7e7190af2c5893eca668d6b4c681a03774a/ckanext-ids-1.0.17.tar.gz",
"platform": null,
"description": "[![Tests](https://github.com/semantic-web-company/ckanext-ids/workflows/Tests/badge.svg?branch=main)](https://github.com/semantic-web-company/ckanext-ids/actions)\n\n# ckanext-ids\n\n**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!\n\n\n## Requirements\n\n**TODO:** For example, you might want to mention here which versions of CKAN this\nextension works with.\n\nIf your extension works across different versions you can add the following table:\n\nCompatibility with core CKAN versions:\n\n| CKAN version | Compatible? |\n| --------------- |-------------|\n| 2.6 and earlier | not tested |\n| 2.7 | not tested |\n| 2.8 | not tested |\n| 2.9 | tested |\n\nSuggested values:\n\n* \"yes\"\n* \"not tested\" - I can't think of a reason why it wouldn't work\n* \"not yet\" - there is an intention to get it working\n* \"no\"\n\n\n## Installation\n\n**TODO:** Add any additional install steps to the list below.\n For example installing any non-Python dependencies or adding any required\n config settings.\n\nTo install ckanext-ids:\n\n1. Activate your CKAN virtual environment, for example:\n\n . /usr/lib/ckan/default/bin/activate\n\n\n2. Clone the source and install it on the virtualenv\n\n git clone https://github.com/semantic-web-company/ckanext-ids.git\n cd ckanext-ids\n pip install -e . \n pip install -r requirements.txt\n \n\n\n3. Add `ids` and `ids_dummy to the `ckan.plugins` setting in your CKAN\n config file (by default the config file is located at\n `/etc/ckan/default/ckan.ini`).\n\n4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:\n\n sudo service apache2 reload\n\n\n## Config settings\n\n # The URL of the local dataspace connector\n ckanext.ids.trusts_local_dataspace_connector_url = http://localhost:8089\n # The username of the local dataspace connector\n ckanext.ids.trusts_local_dataspace_connector_username = admin\n # The password of the local dataspace connector\n ckanext.ids.trusts_local_dataspace_connector_password = password\n\n\n## Developer installation\n\nTo install ckanext-ids for development, activate your CKAN virtualenv and\ndo:\n\n git clone https://github.com/semantic-web-company/ckanext-ids.git\n cd ckanext-ids\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n## Tests\n\nTo run the tests, do:\n\n pytest --ckan-ini=test.ini\n\n\n## Releasing a new version of ckanext-ids\n\nIf ckanext-ids should be available on PyPI you can follow these steps to publish a new version:\n\n1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.\n\n2. Make sure you have the latest version of necessary packages:\n\n pip install --upgrade setuptools wheel twine\n\n3. Create a source and binary distributions of the new version:\n\n python setup.py sdist bdist_wheel && twine check dist/*\n\n Fix any errors you get.\n\n4. Upload the source distribution to PyPI:\n\n twine upload dist/*\n\n5. Commit any outstanding changes:\n\n git commit -a\n git push\n\n6. Tag the new release of the project on GitHub with the version number from\n the `setup.py` file. For example if the version number in `setup.py` is\n 0.0.1 then do:\n\n git tag 0.0.1\n git push --tags\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n\n## Funding\nThis code was created as part of project TRUSTS: Trusted secure data sharing space.\n\nThis project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement [No 871481](https://cordis.europa.eu/project/id/871481).\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "IDS data model extension for CKAN",
"version": "1.0.17",
"project_urls": {
"Homepage": "https://github.com/semantic-web-company/ckanext-ids"
},
"split_keywords": [
"ckan",
"ids"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0c4a046fb17253990f875a74b4277a957814310d658abadce571adba0ba4e90",
"md5": "64e4a0a26324277cb74deb0942202f3e",
"sha256": "8935f6d5820b64b5f267e6b9ddfc580d9cad8bfd69ce3e7aa55f6249ec27cb25"
},
"downloads": -1,
"filename": "ckanext_ids-1.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64e4a0a26324277cb74deb0942202f3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 134227,
"upload_time": "2023-12-29T14:12:54",
"upload_time_iso_8601": "2023-12-29T14:12:54.029879Z",
"url": "https://files.pythonhosted.org/packages/a0/c4/a046fb17253990f875a74b4277a957814310d658abadce571adba0ba4e90/ckanext_ids-1.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94b3d1d052aa5c866c56e1e9b881c7e7190af2c5893eca668d6b4c681a03774a",
"md5": "2a4b426b72b922a6acfa8e9ccbb10dfa",
"sha256": "956d02d833f0be8b94490f78c40e1e243b6664881099dd6695851ff16ecdeabb"
},
"downloads": -1,
"filename": "ckanext-ids-1.0.17.tar.gz",
"has_sig": false,
"md5_digest": "2a4b426b72b922a6acfa8e9ccbb10dfa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 110923,
"upload_time": "2023-12-29T14:12:56",
"upload_time_iso_8601": "2023-12-29T14:12:56.596896Z",
"url": "https://files.pythonhosted.org/packages/94/b3/d1d052aa5c866c56e1e9b881c7e7190af2c5893eca668d6b4c681a03774a/ckanext-ids-1.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 14:12:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "semantic-web-company",
"github_project": "ckanext-ids",
"github_not_found": true,
"lcname": "ckanext-ids"
}