tox-ini-fmt

apply a consistent format to tox.ini files

installation

pip install tox-ini-fmt

as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

  - repo: https://github.com/tox-dev/tox-ini-fmt
    rev: 1.3.1
    hooks:
      - id: tox-ini-fmt
        args: [-p, 'fix_lint,type']

cli

Consult the help for the latest usage:

$ tox-ini-fmt --help
usage: tox-ini-fmt [-h] [-s | --check] [-p toxenv] tox_ini [tox_ini ...]

positional arguments:
  tox_ini       tox ini files to format

options:
  -h, --help    show this help message and exit
  -s, --stdout  print the formatted text to the stdout (instead of update in-place)
  --check       check files are formatted without writing them back (exit code 1 on change)
  -p toxenv     tox environments that pin to the start of the envlist (comma separated)

what does it do?

It does not

Format any other section beside tox/testenv:* (other than put this sections to the end of the file)

General

boolean fields are normalized to true or false
all fields are stripped of white space on both end
values that contain a list are split one value per line (PR/merge friendly)
indent multi-line values by four spaces, and start on new line
substitutions within multi-line (excluding commands) are moved to the start of the list (order kept)

Ordering of sections

Applies the following section order:

tox
testenv
testenv:* - py/pypy envs are ordered in decreasing order by python version, then apply the order defined within envlist part of tox section, you can pin tox elements to the start by using the -p flag
any other section defined within the file

`tox` section

Order by:

envlist - multi-line, start with py envs in decreasing python order, then same with pypy, then everything else
isolated_build - boolean field
skipsdist - boolean field
skip_missing_interpreters - boolean field
minversion

`testenv` section

Order by:

description
passenv - multi-line, one environment name to pass per line, sorted by name
setenv - multi-line, one environment name-value to set per line in format of key=value, sorted by key+value
basepython
skip_install - boolean field
usedevelop - boolean field
deps - multi-line, order by package name (but keep dependencies with package names separate at end), normalize format to remove extra spaces
extras - multi-line, one extra env per line
parallel_show_output - boolean field
commands - one command per line, commands that wrap over multiple lines are indented with line two or later by extra four spaces

Metadata

Release files for tox-ini-fmt 1.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tox-ini-fmt 1.10.0
File	Size	Uploaded
tox_ini_fmt-1.10.0.tar.gz	17.3 kB	Oct 11, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for tox-ini-fmt 1.10.0
File	Interpreter	ABI	Platform	Reset
tox_ini_fmt-1.10.0-py3-none-any.whl 15.0 kB Oct 11, 2026	Python 3	none	any	Details

Total release size: 32.3 kB

Release files / tox_ini_fmt-1.10.0.tar.gz

Download URL	tox_ini_fmt-1.10.0.tar.gz
Size	17.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`c87981255a9f6274c6beaef6069645e9a612424d06a800f3300c2a3dea7e98e1`
BLAKE2b-256 checksum How to use checksums	`b3e53b50f56ca0e4df03a9b0c743d41caa1d8c7b1d9ab7994a7098b0c50b4501`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/tox-dev/tox-ini-fmt
Publishing commit: github.com/tox-dev/tox-ini-fmt/tree/862ac086ad15d25561e66cc5b4af7db6acafa80a

Workflow

Publishing configuration: github.com/tox-dev/tox-ini-fmt/blob/862ac086ad15d25561e66cc5b4af7db6acafa80a/.github/workflows/release.yaml
Publishing logs: github.com/tox-dev/tox-ini-fmt/actions/runs/38092800590/attempts/1

Artifact

Subject: tox_ini_fmt-1.10.0.tar.gz
SHA-256 checksum: c87981255a9f6274c6beaef6069645e9a612424d06a800f3300c2a3dea7e98e1 Verifying attestations

Release files / tox_ini_fmt-1.10.0-py3-none-any.whl

Download URL	tox_ini_fmt-1.10.0-py3-none-any.whl
Size	15.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4ef5a007c8776a8b5b30152153dfce9c0b53313e3860f97e67627b100ba0758e`
BLAKE2b-256 checksum How to use checksums	`926885c6273774eacfd7ad2f140ca33d35871caa3c1bc9dac84f7268f24f9c2e`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/tox-dev/tox-ini-fmt
Publishing commit: github.com/tox-dev/tox-ini-fmt/tree/862ac086ad15d25561e66cc5b4af7db6acafa80a

Workflow

Publishing configuration: github.com/tox-dev/tox-ini-fmt/blob/862ac086ad15d25561e66cc5b4af7db6acafa80a/.github/workflows/release.yaml
Publishing logs: github.com/tox-dev/tox-ini-fmt/actions/runs/38092800590/attempts/1

Artifact

Subject: tox_ini_fmt-1.10.0-py3-none-any.whl
SHA-256 checksum: 4ef5a007c8776a8b5b30152153dfce9c0b53313e3860f97e67627b100ba0758e Verifying attestations