Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Questionnaires in paper form are more and more replaced with digital equivalents, but those are often hardly adaptable to one’s individual wishes. To simplify the use of digital questionnaires, this Python-based open-source framework was developed, that allows to create diverse questionnaires without any programming knowledge. The software has a graphical user interface as well as the possibility to edit the entire questionnaire structure in one configuration text file. Many common question and answer types are already implemented, but the selection will be extended. Furthermore, interfaces for communication with other software and systems are possible, for example OSC. The software is designed so that different components can also run on different computers.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

The necessary python libraries are given in requirements.txt.

• configobj - Structure
• fpdf - Generate pdf file
• msgpack_python - Communication
• ping3 - Connection check
• PySide6 - GUI
• python_osc - OSC communication
• pyzmq - Communication
• timeloop - Repeating jobs

Installation

1. Clone the repo or download the latest stable release

   git clone https://gitlab.uni-hannover.de/da.schoessow/quest.git

2. Install necessary python libraries

   pip install -r requirements.txt

3. Run by executing launcher.exe (located in the folder src) or running

   cd quest
   python src/Launcher.py

(back to top)

Usage

To get started, once you run the launcher, choose "Edit Questionnaire" to create your GUI. With "Run Questionnaire" you can execute your questionnaires.

For more examples and explanation, please refer to the Documentation

(back to top)

Roadmap and TODOs

• Initial public release
  • Test setup (-> see issue #1 )
  • Initialize Wiki
• Additional question types
  • AFC
  • Localisation
• Automatic page generation/templates (e.g. pairwise comparison)
• PyQt6 compatible release
• Editor for *.qss
• Usage of Mad Mapper as video tool (OSC support given)
• Fix pdf export graphic glitches
• svgs for CheckBox and RadioButton
• automatic centering of SliderHeader/MatrixHeader
• images/videos as element for the questionnaire
• support for multiple languages
• "if this answer than go to that page"-logic

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

Daphne Schössow - daphne.schoessow@ikt.uni-hannover.de

Project Link: https://gitlab.uni-hannover.de/da.schoessow/quest

(back to top)