UVOXEN(1)

NAME
uvoxen - configure and run tests

SYNOPSIS
uvoxen list envs

uvoxen list pythons

uvoxen list reqs

uvoxen req generate [- -check] [-f | - -force] [-N | - -noop] [-o path | - -output path] -g group | - -group group

uvoxen [-p python | - -python python] tox generate [- -check] [-f | - -force] [-N | - -noop] [-o path | - -output path]
uvoxen [-p python | - -python python] tox run [-e envlist | - -env envlist] [-f | - -force] [-N | - -noop]

uvoxen [-p python | - -python python] uv run [-e envlist | - -env envlist] [-f | - -force] [-N | - -noop] [- -resolution strategy]

uvoxen - -features
uvoxen -h | - -help

DESCRIPTION
The uvoxen tool allows test environments to be defined in the pyproject.toml file with a syntax relatively similar to the one used for Tox configuration. It can then:
•   run tests defined in these environments using the `uv` tool
•   output Tox configuration and run Tox instead
•   export the dependency groups into text files

See the full documentation in the /usr/share/doc/uvoxen directory or at https://uvoxen.readthedocs.org/ for more information.

SUBCOMMANDS

  list envs - list the defined test environments
The list envs subcommand displays the environments defined in the tool.uvoxen.env table in the pyproject.toml file.

  list pythons - list the supported Python versions
The list pythons subcommand displays the Python versions listed as supported in the project.classifiers list in the pyproject.toml file.

  list reqs - list the defined dependency groups
The list reqs subcommand displays the dependency groups in the dependency-groups table in the pyproject.toml file.

  tox generate - generate the tox.ini file
The tox generate subcommand generates the tox.ini Tox configuration file.

If the - -check option is specified, the file is not modified, and uvoxen exits with a non-zero code if any changes would be made.

If a single dash (“-”) is specified as the argument of the - -output option, the file is not modified, and uvoxen displays the generated contents on its standard output instead.

  tox run - run tests using Tox
The tox run command regenerates the tox.ini Tox configuration file if necessary and then uses the uvx(1) tool to run tox run-parallel with either the specified list of environments or the tool.uvoxen.envlist list in the pyproject.toml file.

If the -p (- -python) command-line option is specified, it is passed on to uvx(1) to use the specified Python version instead of the defualt one. If the special value “supported” is passed as a Python version, then uvoxen invokes Tox for each of the Python versions listed as supported in the project.classifiers list in the pyproject.toml file in succession.

  uv run - run tests using the uv tool
The uv run command runs either the specified list of environments or the tool.uvoxen.envlist list in the pyproject.toml file. For each environment it invokes the uv(1) tool several times:
•   uv sync to install the specified dependencies into the .venv virtual environment
•   uv run for each of the specified commands in succession

If the -p (- -python) command-line option is specified, it is passed on to uv to use the specified Python version instead of the defualt one. If the special value “supported” is passed as a Python version, then uvoxen runs all test environments for each of the Python versions listed as supported in the project.classifiers list in the pyproject.toml file in succession.

AUTHORS
The uvoxen tool was developed by Peter Pentchev <roam@ringlet.net>.