ayu 0.5.0

An interactive TUI for pytest

ayu

ayu is a TUI and pytest-plugin, which allows you to run your pytest tests in a more interactive fashion in your terminal.

Features

Main Screen

• Explore your Test tree
• Mark tests to run, via the test-tree, markers or the search function
• View and filter test results and debug errors

Coverage Viewer

• View your code coverage (first view is just based on a --collect-only)

Plugin Explorer

Currently just exploratory, changes made here are not persisted to your pytest config

• View your plugin options and discover new plugins

Log

• Shows the console output, that would normally be written into the terminal

File Watcher

If toggled, ayu utilizes watchfiles, to detect changes in the directory you declared when executing ayu (default: tests). After a change is detected, a notification is shown and all tests under the specific file will be run automatically.

How does it work

The application starts a local websocket server at localhost:1337 and the plugin sends data about collected tests/plugins/results to the app. The host and port can be customized with the following environment variables

It utilizes uv in the background to run pytest commands. Concrete it runs uv run --with ayu pytest [PYTEST-OPTION] to utilize your python environment and installs the plugin temporary on the fly to send the data to the TUI, without changing your local environment or adding dependencies to your project.

AYU_HOST=localhost
AYU_PORT=1337

Requirements & Usage

Requirements

ayu needs your tests be discoverable by pytest. It works best when your project is managed by uv. Using it without uv may work, but is not supported.

Usage

To discover all your tests under tests

uvx ayu

To discover all your tests under a specific directory

uvx ayu <PATH/TO/DIR>

Feedback and Issues

Feel free to reach out and share your feedback, or open an Issue, if something doesnt work as expected. Also check the Changelog for new updates.