Muffin is a structured reporting solution for test results

Install Python3 (preferrably Python 3.6).

Install dependencies by running (preferrably in a virtualenv)

$ pip install -r requirements.txt

Use the example config in muffin/muffin.cfg.sample and rename it to muffin/muffin.cfg.

Now you should be good to go by running

$ python manage.py runserver

in the top-level folder.

Run

$ py.test

in the root directory to run all the tests.

The rendered API documentation is available here, while the documentation source is available in the source tree in the Swagger specification.

When contributing API changes, please follow the API Guidelines.