Skip to main content

An interactive TUI for pytest

Project description

Ruff PyPI-Server Pyversions License: MIT Downloads Coverage Status

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

preview

  • 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

coverage

  • 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

plugin

  • View your plugin options and discover new plugins

Log

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 project to be uv-managed and you need your tests be discoverable by pytest.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ayu-0.4.4.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ayu-0.4.4-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

Details for the file ayu-0.4.4.tar.gz.

File metadata

  • Download URL: ayu-0.4.4.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ayu-0.4.4.tar.gz
Algorithm Hash digest
SHA256 e9f70048e3ac5dffacf2c1ffb590a76ef9fb23a5b380cc6c29282b9c33cc72c2
MD5 07ff239322524f2617f8eff34352eff7
BLAKE2b-256 42339fdb4d2a613decacf3b64c27c47e7fb5d9a8e41c76ab6737924a3714945b

See more details on using hashes here.

File details

Details for the file ayu-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: ayu-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ayu-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 35eef24d41e65525a284cf616ff0078ab2a7132bebad139685061fac4828e45b
MD5 46668940b4636d3829907f9c820ebde8
BLAKE2b-256 b9e05303e3ca2db35319907bb4e878345d86492e36a736114523636e104c41fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page