ckanext-publicrestrictiondatasets

Adds restrictions to datasets so that only sysadmin users can set visibility to Public. This is in order to make CKAN's behavior match closer how it is described here (https://ckan.org/portfolio/publish-and-manage-data/).

> Admins can approve datasets for publication with our bulk editing tool which let’s you search, facets and pick datasets to become public or private.

For use cases where siloed teams may need to keep certain datasets hidden from public, but stil want to release select datasets and/or catalog for internal purposes. Giving only sysadmins control of when datasets can be set public helps keep this restriction for compliance purposes while still letting Editor users add to the other metadata fields for datasets.

Requirements

For example, you might want to mention here which versions of CKAN this extension works with.

Tested for CKAN v2.9.1

Installation

To install ckanext-publicrestrictiondatasets:

1. Activate your CKAN virtual environment, for example:

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

2. Install the ckanext-publicrestrictiondatasets Python package into your virtual environment:

   pip install ckanext-publicrestrictiondatasets
   

3. Add publicrestrictiondatasets 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

None at present

Developer installation

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

git clone https://github.com/reedv/ckanext-publicrestrictiondatasets.git
cd ckanext-publicrestrictiondatasets
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

To run the tests and produce a coverage report, first make sure you have pytest-cov installed in your virtualenv (pip install pytest-cov) then run:

pytest --ckan-ini=test.ini  --cov=ckanext.publicrestrictiondatasets

Releasing a new version of ckanext-publicrestrictiondatasets

ckanext-publicrestrictiondatasets should be available on PyPI as https://pypi.org/project/ckanext-publicrestrictiondatasets. To publish a new version to PyPI follow these steps:

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