ckanext-downloadall 0.0.1

CKAN extension that adds a "Download all" button to a dataset

ckanext-downloadall

This CKAN extension adds a “Download all” button to datasets. This downloads a zip file containing all the resource files and a datapackage.json.

The datapackage.json is a [Frictionless Data] standard, also known as a Data Package.

If the resource is pushed/xloaded to Datastore then the schema (column types) are included in the datapackage.json file.

This extension uses a CKAN background job to create the zip every time a dataset is created or updated. This suits CKANs where all files are uploaded - if the underlying data file changes without CKAN knowing about it, then the zip will not include the update.

(This extension is inspired by [ckanext-packagezip](https://github.com/datagovuk/ckanext-packagezip), but that is old and relied on ckanext-archiver and IPipe.)

Requirements

Designed to work with CKAN 2.7+

Installation

To install ckanext-downloadall:

1. Activate your CKAN virtual environment, for example:

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

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

   pip install ckanext-downloadall

3. Add downloadall to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

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

   sudo service apache2 reload

Ensure the background job ‘worker’ process is running - see https://docs.ckan.org/en/2.8/maintaining/background-tasks.html#running-background-jobs

Config Settings

None at present

Development Installation

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

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

Remember to run the worker (in a separate terminal):

paster --plugin=ckan jobs worker --config=/etc/ckan/default/development.ini

Running the Tests

To run the tests, do:

nosetests --nologcapture --with-pylons=test.ini

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

nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.downloadall --cover-inclusive --cover-erase --cover-tests

Registering ckanext-downloadall on PyPI

ckanext-downloadall should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-downloadall. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:

1. Create a source distribution of the project:

   python setup.py sdist

2. Register the project:

   python setup.py register

3. Upload the source distribution to PyPI:

   python setup.py sdist upload

4. Tag the first 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

Releasing a New Version of ckanext-downloadall

ckanext-downloadall is availabe on PyPI as https://pypi.python.org/pypi/ckanext-downloadall. 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. Create a source distribution of the new version:

   python setup.py sdist

3. Upload the source distribution to PyPI:

   python setup.py sdist upload

4. 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.2 then do:

   git tag 0.0.2
   git push --tags