CKAN extension for data.gov.uk
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.rst

ckanext-datagovuk

Installation

To install ckanext-datagovuk:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-datagovuk Python package into your virtual environment:

    pip install ckanext-datagovuk
    
  3. Add datagovuk 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
    

Config Settings

Document any optional config settings here.

Development Installation

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

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

Running the Tests

To run the tests, do:

nosetests -v --nologcapture --with-pylons=test.ini --ckan ckanext.datagovuk

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 -v --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.datagovuk --cover-inclusive --cover-erase --cover-tests --ckan ckanext.datagovuk