Metadata-Version: 2.1
Name: OpenQuestion
Version: 0.1.1
Summary: An open source survey platform written in Python.
Home-page: https://github.com/Alcampopiano/OpenQuestion
Author: Allan Campopiano
Author-email: campopianoa@hcdsb.org
License: BSD 3-clause
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# OpenQuestion <a href="https://Alcampopiano.github.io/OpenQuestion/"><img align="right" src="https://github.com/Alcampopiano/OpenQuestion/blob/master/docs/docs/img/logow.png" height="50"></img></a>
[![PyPI version](https://img.shields.io/pypi/v/OpenQuestion?style=flat-square)](https://pypi.org/project/OpenQuestion/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/OpenQuestion?style=flat-square)](https://pypistats.org/packages/OpenQuestion)
[![license](https://img.shields.io/pypi/l/OpenQuestion?style=flat-square)](https://github.com/Alcampopiano/OpenQuestion/blob/master/LICENSE)

OpenQuestion is a survey building and reporting platform written in Python. 
Surveys can be developed using a GUI or by writing Python code. To report on
survey results, OpenQuestion provides a Jupyter-like environment 
for data visualization and document creation.

## Documentation
:book: Please visit the [OpenQuestion documentation site](https://Alcampopiano.github.io/OpenQuestion/).

## Develop surveys with a GUI
![img](docs/docs/img/question_types.gif)

## Surveys are stored as a Python dictionary/JSON

```python
my_survey={
  "title": "simple survey",
  "settings": {
  "survey_color": "#2196F3",
  "thank_you_msg": "#Thank you!"
  },
  "num_widgets": 2,
  "widgets": [
    {
      "id": 0,
      "type": "section",
      "logic": None,
      "title": "section",
      "widgets": [
        {
          "id": 1,
          "type": "text_box",
          "logic": None,
          "title": "what's your name?",
          "number": False,
          "mandatory": True,
          "placeholder": "placeholder here"
        }
      ]
    }
  ]
}
``` 

## Citing OpenQuestion
... coming soon
