Skip to content

OpenDevelopmentMekong/ckanext-odm_agreement

Repository files navigation

ckanext-odm_agreement

Build Status

A CKAN extension which provides with template files and logic to implement OD Mekong's agreements

Installation

In order to install this CKAN Extension:

  • clone the ckanext-odm_agreement folder to the src/ folder in the target CKAN instance.
git clone https://github.com/OpenDevelopmentMekong/ckanext-odm_agreement.git
cd ckanext-odm_agreement
  • Install dependencies pip install -r requirements.txt

  • Setup plugin python setup.py develop

This theme uses ckanext-scheming and ckanext-fluent

In order for this theme to function properly, following CKAN extensions need to be installed:

ckanext-scheming: https://github.com/ckan/ckanext-scheming ckanext-fluent: https://github.com/ckan/ckanext-fluent

and following variables added to the ckan config file (development.ini/production.ini):

scheming.dataset_schemas = ckanext.odm_agreement:odm_agreement_schema.json
scheming.presets = ckanext.odm_agreement:odm_presets.json
                  ckanext.fluent:presets.json
scheming.dataset_fallback = false

Testing

Tests are found on ckanext/odm_agreement/tests and can be run with nosetest

Continuous deployment

Everytime code is pushed to the repository, travis will run the tests available on /tests. In case the code has been pushed to master branch and tests pass, the _ci/deploy.sh script will be called for deploying code in CKAN's DEV instance. Analog to this, and when code from master branch has been tagged as release, travis will deploy to CKAN's PROD instance automatically.

For the automatic deployment, the scripts on _ci/ are responsible of downloading the odm-automation repository, decrypting the odm_tech_rsa.enc private key file ( encrypted using Travis-ci encryption mechanism) and triggering deployment in either DEV or PROD environment.

Copyright and License

This material is copyright (c) 2014-2015 East-West Management Institute, Inc. (EWMI).

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at:

http://www.fsf.org/licensing/licenses/agpl-3.0.html