| Name | ckanext-userdatasets JSON |
| Version |
2.1.10
JSON |
| download |
| home_page | None |
| Summary | A CKAN extension that allows organisation members to create datasets, and edit or delete the datasets they have created. |
| upload_time | 2024-11-04 11:59:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
userdatasets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--header-start-->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
<source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
<img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
</picture>
# ckanext-userdatasets
[](https://github.com/NaturalHistoryMuseum/ckanext-userdatasets/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-userdatasets)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-userdatasets.readthedocs.io)
_A CKAN extension that allows organisation members to create datasets, and edit or delete the datasets they have created._
<!--header-end-->
# Overview
<!--overview-start-->
This extension changes the permissions of users with the 'Member' role in an organisation, allowing them to create
datasets, and to edit or delete the datasets they have created. Unlike users with the 'Editor' role, they cannot
edit or delete datasets created by other users.
Notes:
- This applies to the existing 'Member' role rather than creating a new one as it is currently not possible to add
new roles from an extension;
- The plugin works with custom dataset types, however it will not work with other plugins which override
package/resource update/create/delete authorization functions, and package_create/update actions.
**Warning: This plugin modifies CKAN's permission system. The current implementation cannot be considered fully
safe and should only be used AT YOUR OWN RISK in a trusted environment. Ensure you run the tests with your plugins
enabled.**
<!--overview-end-->
# Installation
<!--installation-start-->
Path variables used below:
- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`
- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`
## Installing from PyPI
```shell
pip install ckanext-userdatasets
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-userdatasets.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-userdatasets
```
### Installing in editable mode
Installing from a `pyproject.toml` in editable mode (i.e. `pip install -e`) requires `setuptools>=64`; however, CKAN 2.9 requires `setuptools==44.1.0`. See [our CKAN fork](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.
## Post-install setup
1. Add 'userdatasets' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... userdatasets
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
There are no configuration options for this extension.
<!--configuration-end-->
# Usage
<!--usage-start-->
## Actions
No new actions are defined in this extension; three are overridden to modify validators and permissions.
### `package_create`
### `package_update`
### `organization_list_for_user`
<!--usage-end-->
# Testing
<!--testing-start-->
There is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the `docker/` folder.
To run the tests against ckan 2.9.x on Python3:
1. Build the required images:
```shell
docker compose build
```
2. Then run the tests.
The root of the repository is mounted into the ckan container as a volume by the Docker compose
configuration, so you should only need to rebuild the ckan image if you change the extension's
dependencies.
```shell
docker compose run ckan
```
<!--testing-end-->
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-userdatasets",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, userdatasets",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/9a/53/6bda85a2e85b76cecfb6377f0ee31fa61dcd4fe65f8fa8619248eb212da7/ckanext_userdatasets-2.1.10.tar.gz",
"platform": null,
"description": "<!--header-start-->\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\">\n <img alt=\"The Natural History Museum logo.\" src=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\">\n</picture>\n\n# ckanext-userdatasets\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-userdatasets/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-userdatasets)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-userdatasets.readthedocs.io)\n\n_A CKAN extension that allows organisation members to create datasets, and edit or delete the datasets they have created._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nThis extension changes the permissions of users with the 'Member' role in an organisation, allowing them to create\ndatasets, and to edit or delete the datasets they have created. Unlike users with the 'Editor' role, they cannot\nedit or delete datasets created by other users.\n\nNotes:\n- This applies to the existing 'Member' role rather than creating a new one as it is currently not possible to add\n new roles from an extension;\n- The plugin works with custom dataset types, however it will not work with other plugins which override\n package/resource update/create/delete authorization functions, and package_create/update actions.\n\n**Warning: This plugin modifies CKAN's permission system. The current implementation cannot be considered fully\n safe and should only be used AT YOUR OWN RISK in a trusted environment. Ensure you run the tests with your plugins\n enabled.**\n\n<!--overview-end-->\n\n# Installation\n\n<!--installation-start-->\nPath variables used below:\n- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`\n- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`\n\n## Installing from PyPI\n\n```shell\npip install ckanext-userdatasets\n```\n\n## Installing from source\n\n1. Clone the repository into the `src` folder:\n ```shell\n cd $INSTALL_FOLDER/src\n git clone https://github.com/NaturalHistoryMuseum/ckanext-userdatasets.git\n ```\n\n2. Activate the virtual env:\n ```shell\n . $INSTALL_FOLDER/bin/activate\n ```\n\n3. Install via pip:\n ```shell\n pip install $INSTALL_FOLDER/src/ckanext-userdatasets\n ```\n\n### Installing in editable mode\n\nInstalling from a `pyproject.toml` in editable mode (i.e. `pip install -e`) requires `setuptools>=64`; however, CKAN 2.9 requires `setuptools==44.1.0`. See [our CKAN fork](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.\n\n## Post-install setup\n\n1. Add 'userdatasets' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... userdatasets\n ```\n\n<!--installation-end-->\n\n# Configuration\n\n<!--configuration-start-->\nThere are no configuration options for this extension.\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Actions\n\nNo new actions are defined in this extension; three are overridden to modify validators and permissions.\n\n### `package_create`\n\n### `package_update`\n\n### `organization_list_for_user`\n\n<!--usage-end-->\n\n# Testing\n\n<!--testing-start-->\nThere is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the `docker/` folder.\n\nTo run the tests against ckan 2.9.x on Python3:\n\n1. Build the required images:\n ```shell\n docker compose build\n ```\n\n2. Then run the tests.\n The root of the repository is mounted into the ckan container as a volume by the Docker compose\n configuration, so you should only need to rebuild the ckan image if you change the extension's\n dependencies.\n ```shell\n docker compose run ckan\n ```\n\n<!--testing-end-->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A CKAN extension that allows organisation members to create datasets, and edit or delete the datasets they have created.",
"version": "2.1.10",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-userdatasets/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-userdatasets"
},
"split_keywords": [
"ckan",
" data",
" userdatasets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8851393945f9573a02adf010e494a2b6c6e939dbe31d1ba08ef79681c8148de4",
"md5": "3b0b4aede63f107b1117048e8416d487",
"sha256": "733871f5aa53232d839b300653d1a8575c104f173abd03b00146bce08164673f"
},
"downloads": -1,
"filename": "ckanext_userdatasets-2.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b0b4aede63f107b1117048e8416d487",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 24434,
"upload_time": "2024-11-04T11:59:17",
"upload_time_iso_8601": "2024-11-04T11:59:17.596315Z",
"url": "https://files.pythonhosted.org/packages/88/51/393945f9573a02adf010e494a2b6c6e939dbe31d1ba08ef79681c8148de4/ckanext_userdatasets-2.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a536bda85a2e85b76cecfb6377f0ee31fa61dcd4fe65f8fa8619248eb212da7",
"md5": "934274f8835ff6a9b4086d322d3fb317",
"sha256": "56453af8d37ac979c993828cfb9894481a76a398546c3f2b76790dfc991f52f8"
},
"downloads": -1,
"filename": "ckanext_userdatasets-2.1.10.tar.gz",
"has_sig": false,
"md5_digest": "934274f8835ff6a9b4086d322d3fb317",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 24237,
"upload_time": "2024-11-04T11:59:19",
"upload_time_iso_8601": "2024-11-04T11:59:19.267565Z",
"url": "https://files.pythonhosted.org/packages/9a/53/6bda85a2e85b76cecfb6377f0ee31fa61dcd4fe65f8fa8619248eb212da7/ckanext_userdatasets-2.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:59:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-userdatasets",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-userdatasets"
}
