Repository files navigation

DataPusher is a standalone web service that automatically downloads any CSV orXLS (Excel) data files from a CKAN site's resources when they are added to theCKAN site, parses them to pull out the actual data, then uses the DataStore APIto push the data into the CKAN site's DataStore.

This makes the data from the resource files available via CKAN's DataStore API.In particular, many of CKAN's data preview and visualization plugins will onlywork (or will work much better) with files whose contents are in the DataStore.

To get it working you have to:

1. Deploy a DataPusher instance to a server (or use an existing DataPusherinstance)
2. Enable and configure thedatastore plugin on your CKAN site.
3. Enable and configure thedatapusher plugin on your CKAN site.

For details see theDataPusher documentation.

Note that if you installed CKAN using thepackage install option then aDataPusher instance should be automatically installed and configured to workwith your CKAN site.

DataPusher is a replacement forDataStorer.It's built usingCKAN Service Provider andMessytables.

The original author of DataPusher wasDominik Moritzdominik.moritz@okfn.org. For the current list of contributorsseegithub.com/ckan/datapusher/contributors

To install DataPusher for development:

git clone https://github.com/ckan/datapusher.gitcd datapusherpip install -r requirements-dev.txt

To run the tests:

nosetests

To build the documentation:

pip install -r doc-requirements.txtpython setup.py build_sphinx

To release a new version of DataPusher:

1. Increment the version number insetup.py

2. Build a source distribution of the new version and publish it toPyPI:

   python setup.py sdistpython setup.py sdist upload

   You may want to test installing and running the new version from PyPI in aclean virtualenv before continuing to the next step.

3. Commit your setup.py changes to git, tag the release, and push the changesand the tag to GitHub:

   git commit setup.py -m"Bump version number"git tag 0.0.1git pushgit push origin 0.0.1

   (Replace both instances of 0.0.1 with the number of the version you'rereleasing.)