This extension includes the assets, styles and javascript functionality of govuk-frontend to enable data publication services to be implemented using ckan for hosting on GOV.UK
To install ckanext-govuk:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-govuk Python package into your virtual environment:
pip install ckanext-govuk (not currently available via pip)
Add
govuk
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/production.ini
).Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource # (optional, default: 24). ckanext.govuk.some_setting = some_default_value
To install ckanext-govuk for development, activate your CKAN virtualenv and do:
git clone https://github.com/LandRegistry/ckanext-govuk.git cd ckanext-govuk python setup.py develop pip install -r dev-requirements.txt
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.govuk --cover-inclusive --cover-erase --cover-tests
ckanext-govuk should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-govuk. If that link doesn't work, then you can register the project on PyPI for the first time by following these steps:
Create a source distribution of the project:
python setup.py sdist
Register the project:
python setup.py register
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the first release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.1 then do:git tag 0.0.1 git push --tags
ckanext-govuk is availabe on PyPI as https://pypi.python.org/pypi/ckanext-govuk. To publish a new version to PyPI follow these steps:
Update the version number in the
setup.py
file. See PEP 440 for how to choose version numbers.Create a source distribution of the new version:
python setup.py sdist
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the new release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.2 then do:git tag 0.0.2 git push --tags
Currently this ckan extension uses the minified versions of the govuk assets to implement all of the govuk styles and functionality. In order to update to the latest version of the govuk frontend then you will need to follow the manual steps below:
- Download the latest version of the govuk-frontend assets.
- Put all of the downloaded fonts and images into the appriopriate folder in
ckanext/public/assets
, replacing the files already in there. - Put all of the minified css and javascript files into the folder
ckanext/public
, replacing the files already in there. - Update all of the links for the css and javascript in
ckanext/templates/base.html
to point to the latest versions.
CKAN
GOV.UK Frontend