cequencer/civomega

Ask questions about government data.

CivOmega

CivOmega makes it easy for anyone to get answers from open datasets and APIs. It is powered by "question modules" which are written and contributed by civic minded developers. These modules are intentionally simple and lightweight, and map question patterns to API calls and queries against datasets.

If you are a developer interested in contributing a question module, we suggest you start by forking our CivOmega Module Bootstrap. Once you are happy with the module, raise an issue in this repository requesting that the module be added to CivOmega.

Setting Up CivOmega Core

You are going to need Python and Git on your development environment to be able to contribute to CivOmega Core or build a CivOmega Module.

• OSX Setup Instructions
• Unix / Linux Setup Instructions

Contributing

If you are a developer interested in contributing a question module, start by taking a look at our CivOmega Module Documentation. Once you are happy with your module, raise an issue explaining your module, and requesting that it be added to CivOmega. We will then review the module and respond with any feedback.

If you are a developer interested in contributing to CivOmega Core, there is a small amount of developer-specific documentation available related to the core project. See CONTRIBUTING.md and the files in the doc directory.

Structure

civomega.data represents Django models & functionality related to the question-answering Modules, DataSources, QuestionPatterns and the like.

civomega.cologger represents Django models & functionality related to logging of user input, detecting whether answer-generation is taking too long, etc.