Skip to main content

CKAN Extension providing Issues (Task/Todos/...)

Project description

CI Actions Status Coverage Status Python CKAN

CKAN Issues Extension

This extension allows users to to report issues with datasets in a CKAN instance.

Requirements

This extension works with CKAN 2.9+.

Installation

To install the plugin, enter your virtualenv and install from pip or source:

pip install ckanext-isssues

pip install -e git+http://github.com/keitaroinc/ckanext-issues

Create the necessary tables:

ckan -c path-to/ckan.ini issuesdb

This will also register a plugin entry point, so you now should be able to add the following to your CKAN .ini file::

ckan.plugins = issues

After you clear your cache and restart the web server, the Issues extension should be available.

Upgrade from older versions

When upgrading ckanext-issues from older code versions, you should run the issues upgrade command, in case there are any model migrations (e.g. 11th Jan 2016):

ckan -c path-to/ckan.ini issuesupdate

What it does

Once installed and enabled, the issues extension will make available a per- dataset issue tracker.

The issue tracker user interface can be found at:

/dataset/{dataset-name-or-id}/issues

You can add an issue at:

/dataset/{dataset-name-or-id}/issues/new

Issues API

The issues extension also exposes its functionality as part of the standard CKAN Action API:

Specifically:

/api/3/action/issue_show
/api/3/action/issue_create
/api/3/action/issue_update
/api/3/action/issue_delete
/api/3/action/issue_search
/api/3/action/issue_count
/api/3/action/issue_comment_create
/api/3/action/issue_report
/api/3/action/issue_report_clear
/api/3/action/issue_comment_report
/api/3/action/issue_comment_report_clear

Configuration

To switch-on notifications, you should set the following option in your configuration, and all users in the group will get the email.

ckanext.issues.send_email_notifications = true

If you set max_strikes then users can 'report' a comment as spam/abuse. If the number of users reporting a particular comment hits the max_strikes number then it is hidden, pending moderation.

ckanext.issues.max_strikes = 2

Activation

By default, issues are enabled for all datasets. If you wish to restrict issues to specific datasets or organizations, you can use these config options:

ckanext.issues.enabled_for_datasets = mydataset1 mydataset2 ...
ckanext.issues.enabled_for_organizations = department-of-transport health-regulator

Alternatively, you can switch issues on/off for particular datasets by using an extra field:

'issues_enabled': True

and you can set the default for all the other datasets (without that extra field):

ckanext.issues.enabled_without_extra = false

For the extra field to work you must not set enabled_per_dataset or enabled_for_organizations options.

Feedback

Please open an issue in the github issue tracker.

Developers

Normal requirements for CKAN Extensions (including an installation of CKAN and its dev requirements). Contributions welcome.

Testing with Postgres

To run full production tests on postgres run. These are the tests that the travis build will run

pytest --ckan-ini=test.ini ckanext/issues/tests

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-issues-1.0.0.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

ckanext_issues-1.0.0-py3-none-any.whl (88.1 kB view details)

Uploaded Python 3

File details

Details for the file ckanext-issues-1.0.0.tar.gz.

File metadata

  • Download URL: ckanext-issues-1.0.0.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ckanext-issues-1.0.0.tar.gz
Algorithm Hash digest
SHA256 90b6ddc81699c7deb977a43737cb3a2ea75e875972a5f5be0535d25f5ed61af5
MD5 2387c6e407a858a7d6a7206c5f8612d0
BLAKE2b-256 6e1b9242f160d058723a31f9a1a8711c36c2d31ddf947095c780e84ab6b400f6

See more details on using hashes here.

File details

Details for the file ckanext_issues-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: ckanext_issues-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 88.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ckanext_issues-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58c1f3e31528f85c108426eae8b57b9664ec398ff292cc70f2bcf54c3b22bb92
MD5 984e099cd530fc2bdcba757068410a1e
BLAKE2b-256 1c6d6f56370576e362945c5ef067bd7bf92ef46a8f46e7b7ec9b400d9c4f347e

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