ckanext-biskit

This is the main repo for the BISKIT Data Portal. All of the CKAN customizations are added in this extension.

Getting Started

Requirements

This extension works with CKAN 2.8.x.

Installation

To install ckanext-biskit:

1. Activate your CKAN virtual environment, for example:

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

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

   pip install ckanext-biskit

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

Optional:

# An optional setting to control whether to display the debug link in the footer
# when running in debug mode
ckanext.biskit.show_debug_link = true

Development

Development Installation

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

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

All code MUST follow PEP8 Style Guide. Most editors have plugins or integrations and automatic checking for PEP8 compliance so make sure you use them.

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.biskit --cover-inclusive --cover-erase --cover-tests