tox is a generic virtualenv management and test command line tool
Project description
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] [-p toxenv] tox_ini
positional arguments:
tox_ini tox ini file to format
optional arguments:
-h, --help show this help message and exit
-s, --stdout print the formatted text to the stdout (instead of update in-place)
-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 totrue
orfalse
- 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 withinenvlist
part oftox
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 withpy
envs in decreasing python order, then same withpypy
, then everything elseisolated_build
-boolean
fieldskipsdist
-boolean
fieldskip_missing_interpreters
-boolean
fieldminversion
testenv
section
Order by:
description
passenv
- 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+valuebasepython
skip_install
-boolean
fieldusedevelop
-boolean
fielddeps
- 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
-boolean
fieldcommands
- one command per line, commands that wrap over multiple lines are indented with line two or later by extra four spaces
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tox_ini_fmt-1.5.0.tar.gz
.
File metadata
- Download URL: tox_ini_fmt-1.5.0.tar.gz
- Upload date:
- Size: 16.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
4dd3580d897f705bcff9d9391a7de3853639db82e04dbe1c568e53a031219d40
|
|
MD5 |
536a9f27c07cd61c1f83ad85319389fb
|
|
BLAKE2b-256 |
02dae69909facfbaefff0eb3267de52103a76a18142da1f000afe68f9fa778ee
|
Provenance
The following attestation bundles were made for tox_ini_fmt-1.5.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.5.0.tar.gz
-
Subject digest:
4dd3580d897f705bcff9d9391a7de3853639db82e04dbe1c568e53a031219d40
- Sigstore transparency entry: 164203808
- Sigstore integration time:
-
Permalink:
tox-dev/tox-ini-fmt@e732f664aa3fd7b32cce3de8abbac43f4c3c375d
-
Branch / Tag:
refs/tags/1.5.0
- Owner: https://github.com/tox-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@e732f664aa3fd7b32cce3de8abbac43f4c3c375d
-
Trigger Event:
push
-
Statement type:
File details
Details for the file tox_ini_fmt-1.5.0-py3-none-any.whl
.
File metadata
- Download URL: tox_ini_fmt-1.5.0-py3-none-any.whl
- Upload date:
- Size: 14.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
345b800525fb6e9669e38f50d4a1df9bf385cf3c83d6166c5ba2a0845bbc7f7a
|
|
MD5 |
0786b51b315116e0f041be289a69f67f
|
|
BLAKE2b-256 |
cadb94b2acef0bd4ede2d664c02ba92e98d12ab6d2b3068661020bec783b1586
|
Provenance
The following attestation bundles were made for tox_ini_fmt-1.5.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.5.0-py3-none-any.whl
-
Subject digest:
345b800525fb6e9669e38f50d4a1df9bf385cf3c83d6166c5ba2a0845bbc7f7a
- Sigstore transparency entry: 164203809
- Sigstore integration time:
-
Permalink:
tox-dev/tox-ini-fmt@e732f664aa3fd7b32cce3de8abbac43f4c3c375d
-
Branch / Tag:
refs/tags/1.5.0
- Owner: https://github.com/tox-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@e732f664aa3fd7b32cce3de8abbac43f4c3c375d
-
Trigger Event:
push
-
Statement type: