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
booleanfields are normalized totrueorfalse- 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:
toxtestenvtestenv:*-py/pypyenvs are ordered in decreasing order by python version, then apply the order defined withinenvlistpart oftoxsection, you can pin tox elements to the start by using the-pflag- any other section defined within the file
tox section
Order by:
envlist- multi-line, start withpyenvs in decreasing python order, then same withpypy, then everything elseisolated_build-booleanfieldskipsdist-booleanfieldskip_missing_interpreters-booleanfieldminversion
testenv section
Order by:
descriptionpassenv- multi-line, one environment name to pass per line, sorted by namesetenv- multi-line, one environment name-value to set per line in format ofkey=value, sorted by key+valuebasepythonskip_install-booleanfieldusedevelop-booleanfielddeps- multi-line, order by package name (but keep dependencies with package names separate at end), normalize format to remove extra spacesextras- multi-line, one extra env per lineparallel_show_output-booleanfieldcommands- one command per line, commands that wrap over multiple lines are indented with line two or later by extra four spaces
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tox_ini_fmt-1.9.0.tar.gz
(17.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tox_ini_fmt-1.9.0.tar.gz.
File metadata
- Download URL: tox_ini_fmt-1.9.0.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcde1e00624fcf6fd1280dbef1ffa8a4bd536fe3e05076730e8cb6b89e0859a4
|
|
| MD5 |
4351b993c6698d6d497f1ce3121a44ed
|
|
| BLAKE2b-256 |
0f3052ba92f7017218da099345741796699fe5d15431a5dfb522c1f837b78540
|
Provenance
The following attestation bundles were made for tox_ini_fmt-1.9.0.tar.gz:
Publisher:
release.yaml on tox-dev/tox-ini-fmt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tox_ini_fmt-1.9.0.tar.gz -
Subject digest:
fcde1e00624fcf6fd1280dbef1ffa8a4bd536fe3e05076730e8cb6b89e0859a4 - Sigstore transparency entry: 2458540342
- Sigstore integration time:
-
Permalink:
tox-dev/tox-ini-fmt@241ced4140307006cfd8b2b9ccfd43b1139cfe4a -
Branch / Tag:
refs/tags/1.9.0 - Owner: https://github.com/tox-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@241ced4140307006cfd8b2b9ccfd43b1139cfe4a -
Trigger Event:
push
-
Statement type:
File details
Details for the file tox_ini_fmt-1.9.0-py3-none-any.whl.
File metadata
- Download URL: tox_ini_fmt-1.9.0-py3-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ed3ac58b7b64a6eecaf696f3c3a1865af06f98a40c60f0603257de119b6afde
|
|
| MD5 |
7f799f5ddc3aba14b975c1d3efe77f02
|
|
| BLAKE2b-256 |
492bc1a0e3609a80ffb233ca350754260c30ee88eb2d3aa5c6f9a2a210a972e1
|
Provenance
The following attestation bundles were made for tox_ini_fmt-1.9.0-py3-none-any.whl:
Publisher:
release.yaml on tox-dev/tox-ini-fmt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tox_ini_fmt-1.9.0-py3-none-any.whl -
Subject digest:
6ed3ac58b7b64a6eecaf696f3c3a1865af06f98a40c60f0603257de119b6afde - Sigstore transparency entry: 2458540487
- Sigstore integration time:
-
Permalink:
tox-dev/tox-ini-fmt@241ced4140307006cfd8b2b9ccfd43b1139cfe4a -
Branch / Tag:
refs/tags/1.9.0 - Owner: https://github.com/tox-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@241ced4140307006cfd8b2b9ccfd43b1139cfe4a -
Trigger Event:
push
-
Statement type:
