pyMUSHRA

Description

pyMUSHRA is a python web application which hosts webMUSHRA experiments and collects the data with python.

Quick Start

You can quickly spin up a pyMUSHRA server using uvx or pipx:

uvx pymushra -w <path/to/webmushra-sourcedir> server

or

pipx run pymushra -w <path/to/webmushra-sourcedir> server

Installation

You can also install pyMUSHRA in a project using

uv add pymushra
uv run pymushra server

or

pip install pymushra
pymushra server

Then open http://localhost:5000/admin/

Debugging

You may use the additional tools

uvx pymushra db

to load and inspect the TinyDB connection and

uvx pymushra df [collection]

to inspect the Pandas DataFrame export the TinyDB collection.

Server Installation

For a long-running pyMUSHRA installation, please do not use the builtin server but instead use a proper HTTP server, like Apache or Nginx. See DEPLOYMENT.md for installation instructions.