pymushra 0.3

webMUSHRA server in Python

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 uv or pipx:

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

or install in a project using

uv add pymushra
pip install pymushra

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.