HuBoard "agile board" view of our issues: https://huboard.com/OpenDataServices/cove

CoVE is an web application to Convert, Validate and Explore data following certain open data standards - currently 360Giving and the Open Contracting Data standard. http://cove.opendataservices.coop

CoVE is current in an alpha/beta state.

The W3C Data on the Web Best Practices recommend making open data available in a range of formats to meet the needs of different users. Developers may want JSON, researchers might prefer a spreadsheet format.

CoVE manages the process of converting between JSON, Excel and CSV formats for structured data.

CoVE presents key validation information during the process, and can be configured to display information about the contents of a data file, so that it can be easily inspected.

CoVE currently supports conversion from:

• JSON to multi-tabbed Excel files
• Excel to JSON (it uses the flatten-tool for conversion)

If a JSON schema is supplied, CoVE can use either field names, or user-friendly column titles.

CoVE is in constant development. There are public instances in use at: http://cove.opendataservices.coop/ http://standard.open-contracting.org/validator/

We deploy the latest version of CoVE at the end of each calendar month (usually the last Thursday of the Month). We make development version ready for user testing (mainly internally) two weeks before deployment. Our cut off date for new features to be considered in that cycle is the week before that.

Feature requests, bugs, questions and answers etc are all handled via GitHub. We use release cycle milestones to organise those issues. We also use Huboard as a way to prioritise issues and indicate what is being worked on.

Serious Bug fixes and 'priority' features, that need to make it into a release at short notice can be included by negotiation.

This application is built using Django and Python 3

Steps to installation:

• Clone the repository
• Change into the cloned repository
• Create a virtual environment (note this application uses python3)
• Activate the virtual environment
• Install dependencies
• Set up the database (sqlite3)
• Compile the translations
• Run the development server

git clone https://github.com/OpenDataServices/cove.git
cd cove
virtualenv .ve --python=/usr/bin/python3
source .ve/bin/activate
pip install -r requirements_dev.txt
python manage.py migrate
python manage.py compilemessages
python manage.py runserver

Follow the instructions in your terminal to open the aplication in your browser.

See https://github.com/OpenDataServices/cove/blob/master/DEPLOYMENT.md

py.test

To generate a coverage report (in the htmlcov directory):

py.test --cov cove --cov-report html

The tests include functional tests (actually interacting with the website in selenium). These can also be run against a deployed copy of the website:

CUSTOM_SERVER_URL=http://dev.cove.opendataservices.coop py.test fts 

We also use flake8 to test code quality, see https://github.com/OpenDataServices/developer-docs/blob/master/tests.md#flake8

Translators can provide translations for this application by becomming a collaborator on Transifex https://www.transifex.com/OpenDataServices/cove

For more information about Django's translation framework, see https://docs.djangoproject.com/en/1.8/topics/i18n/translation/

If you add new text to the interface, ensure to wrap it in the relevant gettext blocks/functions.

In order to generate messages and post them on transifex:

python manage.py makemessages -l en
tx push -s

In order to fetch messages from transifex:

tx pull -a

In order to compile them:

python manage.py compilemessages

Do not do not this process on every text change so as not to pollute the commit diffs. Keep the makemessages and pull messages steps in thier own commits seperate from the text changes.

The aim is to run this process each month, but it can be done more regulularly if needed.

To check that all new text is written so that it is able to be translated you could install and run django-template-i18n-lint

pip install django-template-i18n-lint
django-template-i18n-lint cove