rut is a modern and fully-featured test runner for Python's unittest framework, with simplicity as a core design goal.
Sponsored by asserto.ai
- Blazingly Fast (to type):
rutis only 3 characters. - Built-in support for async code.
- Test discovery with keyword-based filtering.
- Topological test ordering by import dependencies.
- Incremental testing: only run tests affected by changes.
- Code coverage support.
Are you a fan of the stability and explicitness of unittest, but wish you had a better runner experience? rut is your drop-in upgrade.
- Zero-Config Discovery: Just run
rut. No more writingif __name__ == '__main__':boilerplate. - First-Class
asyncioSupport:rutautomatically detects and runsasynctests correctly. No moreasyncio.run()wrappers. - Powerful Filtering: Run exactly the tests you want with simple keyword filtering (
-k "my_feature"). - Integrated Coverage: Get a full coverage report with a single flag (
--cov).
Do you appreciate the power of modern test runners, but find yourself wrestling with the complexity and "magic" of third-party frameworks? rut offers a compelling alternative, embracing the explicitness of the standard library.
- No Magic, Just Python:
rutis built directly onunittest. There are no hidden hooks, complex fixture systems, or assertion rewriting. Your tests are plain, debuggable Python. - Familiar, Powerful Features: Get the features you rely on, like keyword filtering (
-k), failing fast (-x), and seamlessasynciosupport, without the overhead of a large framework. - A Leaner Dependency Tree:
rutis a single, focused tool, not a sprawling ecosystem. Keep your project's dependencies clean and understandable.
Add rut as a development dependency to your project:
uv add --dev rutrut [options] [path]To run all tests in the tests/ directory that have the word "feature" in their name, you would run:
rut -k "feature"| Option | Short | Description |
|---|---|---|
--keyword |
-k |
Only run tests that match the given keyword. |
--exitfirst |
-x |
Exit on the first failure. |
--capture |
-s |
Disable all output capturing. |
--alpha |
-a |
Sort tests alphabetically instead of by import dependencies. |
--changed |
-c |
Only run tests affected by file changes since last successful run. |
--dry-run |
List tests in execution order without running them. | |
--verbose |
-v |
Show import dependency ranking. |
--cov |
Run with code coverage. | |
--version |
-V |
Show version and exit. |
--test-base-dir |
The base directory for conftest.py discovery. |
| Argument | Description | Default |
|---|---|---|
path |
The path to the tests to be discovered. | tests |
rut can be configured via the [tool.rut] section in your pyproject.toml file.
Specifies the source directories for coverage reporting, incremental testing (--changed), and import dependency analysis. If not configured, the default is ["src", "tests"].
[tool.rut]
source_dirs = ["my_app", "libs/my_lib"]To add custom warning filters, use the warning_filters key. The format for each filter is a string that follows the warnings.filterwarnings format: action:message:category:module.
[tool.rut]
warning_filters = [
"error::UserWarning:pydantic",
]To specify the base directory for conftest.py discovery, use the test_base_dir key.
[tool.rut]
test_base_dir = "my_tests"For standard, synchronous tests, you can use the standard unittest.TestCase.
import unittest
class MyTest(unittest.TestCase):
def test_something(self):
self.assertEqual(1 + 1, 2)To write an asynchronous test, you must use unittest.IsolatedAsyncioTestCase as the base class for your test case. rut will automatically detect and correctly run async def test methods within these classes.
import asyncio
import unittest
class MyAsyncTest(unittest.IsolatedAsyncioTestCase):
async def test_something_async(self):
await asyncio.sleep(0.01)
self.assertTrue(True)Use the --changed flag to only run tests affected by file changes since the last successful test run. This includes tests whose source files changed, as well as tests that depend on changed modules (transitive dependencies).
# First run builds the cache
rut
# Subsequent runs with --changed only run affected tests
rut --changedThe cache is stored in .rut_cache/ and tracks file hashes. It is only updated after a successful test run.
Note: Files must be in directories listed in source_dirs config to be tracked. The default is ["src", "tests"].
For more complex testing scenarios, you may need to run setup code once before any tests start and teardown code once after all tests have finished. rut supports this with special, automatically-discovered "hook" functions.
To use this feature, create a conftest.py file in your test base directory (usually tests/). rut will automatically find and execute the following functions if they are defined:
rut_session_setup(): Executed once before the test session begins.rut_session_teardown(): Executed once after the test session ends, even if tests fail.
Both of these functions can be synchronous (def) or asynchronous (async def).
# tests/conftest.py
import asyncio
from my_app.database import connect_db, disconnect_db
async def rut_session_setup():
print("Setting up the test database...")
await connect_db()
async def rut_session_teardown():
print("Tearing down the test database...")
await disconnect_db()When rut is running, it sets the environment variable TEST_RUNNER to the value rut. You can use this in your test code to enable or disable functionality that is specific to the test runner.
import os
if os.environ.get('TEST_RUNNER') == 'rut':
# Do something specific to rut
passA Claude Code skill is included in the claude-skill/ folder. This teaches Claude to use rut instead of pytest when running tests.
To install, symlink the skill to your Claude Code skills directory:
ln -s /path/to/rut/claude-skill ~/.claude/skills/rut-testingThis project is licensed under the MIT License - see the LICENSE file for details.