riordan / civomega-mod-bootstrap

The base code to use when creating a civomega module

CivOmega: Question Module Bootstrap

This is a dummy module for CivOmega. CivOmega Modules are what connect datasets and APIs to question patterns.

Note: This repository is where you should start if you want to allow people to ask questions about a dataset or API that doesn't exist in CivOmega already. If you're actually interested in adding more questions to a dataset that already exists, we suggest that you contribute to an existing module instead of creating a new one from the ground up.

Modules have the following components:

• parsers.py - this is where you define question routes and answer logic
• patterns.py - this is where you define the list of question patterns that your module knows how to answer
• templates - this is where you define the output format for your answers

Creating a Module

Read the CivOmega Module documentation to understand how to use this boilerplate to develop a new module.