tox-ini-fmt formats your tox file for you
Project description
tox-ini-fmt
setup-cfg-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: "0.2.0"
hooks:
- id: tox-ini-fmt
cli
Consult the help for the latest usage:
$ tox-ini-fmt --help
usage: tox-ini-fmt [-h] [-s] 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)```
what does it do?
General
boolean
fields are normalized totrue
orfalse
- are 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 two space, and start on new line
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- 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
- one environment name to pass per line, sorted by namesetenv
- 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 two space
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
tox_ini_fmt-0.2.0.tar.gz
(16.8 kB
view hashes)
Built Distribution
Close
Hashes for tox_ini_fmt-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83b87082383c22f5018a42d0282b35acb124eb053049d73435eed7e002a521d6 |
|
MD5 | 8bab8d2b5190dc7957232631571330fc |
|
BLAKE2b-256 | 94988c1f4f5b47af2f28331d7ce8c137dca9d741df7ceb6132a3eaed965a1c48 |