Skip to content

Document headless testing environment variables #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yprez merged 1 commit into from
Nov 10, 2025
Merged

Document headless testing environment variables #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This repository contains a Python synthesizer and its accompanying tests.
- Build/Install: `uv sync`
- Run app: `uv run python main.py`
- Lint: `uv run ruff check .`
- Run all tests: `uv run pytest`
- Run single test: `uv run pytest tests/test_file.py::TestClass::test_function -v`
- Test with coverage: `uv run pytest --cov=qwerty_synth --cov-report=html`
- Run all tests: `PYNPUT_BACKEND=dummy QT_QPA_PLATFORM=offscreen uv run pytest`
- Run single test: `PYNPUT_BACKEND=dummy QT_QPA_PLATFORM=offscreen uv run pytest tests/test_file.py::TestClass::test_function -v`
- Test with coverage: `PYNPUT_BACKEND=dummy QT_QPA_PLATFORM=offscreen uv run pytest --cov=qwerty_synth --cov-report=html`

## Code Practices

Expand Down Expand Up @@ -51,7 +51,8 @@ This repository contains a Python synthesizer and its accompanying tests.
1. Install dependencies with `uv sync`.
2. Ensure the system package `portaudio19-dev` is installed.
3. Run the linter using `uv run ruff check .` and fix issues when possible.
4. Execute the tests: `uv run pytest`.
4. Execute the tests with `PYNPUT_BACKEND=dummy` and `QT_QPA_PLATFORM=offscreen`:
`PYNPUT_BACKEND=dummy QT_QPA_PLATFORM=offscreen uv run pytest`.

## Project Structure

Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,11 @@ Note: MIDI controller input and MIDI file playback are separate features that ca
Run the test suite to verify everything is working correctly:

```bash
uv run pytest
PYNPUT_BACKEND=dummy QT_QPA_PLATFORM=offscreen uv run pytest
```

The environment variables enable headless mode for running tests without a display or X11 server.

## Usage tips

* You can tweak the envelope (ADSR) in real time while playing notes.
Expand Down