| Name | tox-ini-fmt JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | |
| Summary | tox is a generic virtualenv management and test command line tool |
| upload_time | 2023-04-07 05:33:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
environments
isolated
testing
virtual
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tox-ini-fmt
[](https://pypi.org/project/tox-ini-fmt)
[](https://pypi.org/project/tox-ini-fmt)
[](https://pypi.org/project/tox-ini-fmt)
[](https://pypistats.org/packages/tox-ini-fmt)
[](https://opensource.org/licenses/MIT)
[](https://codecov.io/gh/pypa/virtualenv)
[](https://github.com/psf/black)
apply a consistent format to `tox.ini` files
## installation
`pip install tox-ini-fmt`
## as a pre-commit hook
See [pre-commit](https://github.com/pre-commit/pre-commit) for instructions
Sample `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/tox-dev/tox-ini-fmt
rev: "1.1.0"
hooks:
- id: tox-ini-fmt
args: ["-p", "fix_lint,type"]
```
## cli
Consult the help for the latest usage:
```console
$ 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 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:
1. `tox`
2. `testenv`
3. `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
4. any other section defined within the file
### `tox` section
Order by:
1. `envlist` - multi-line, start with `py` envs in decreasing python order, then same with `pypy`, then everything else
2. `isolated_build` - `boolean` field
3. `skipsdist` - `boolean` field
4. `skip_missing_interpreters` - `boolean` field
5. `minversion`
### `testenv` section
Order by:
1. `description`
2. `passenv` - multi-line, one environment name to pass per line, sorted by name
3. `setenv` - multi-line, one environment name-value to set per line in format of `key=value`, sorted by key+value
4. `basepython`
5. `skip_install` - `boolean` field
6. `usedevelop` - `boolean` field
7. `deps` - multi-line, order by package name (but keep dependencies with package names separate at end), normalize
format to remove extra spaces
8. `extras` - multi-line, one extra env per line
9. `parallel_show_output` - `boolean` field
10. `commands` - one command per line, commands that wrap over multiple lines are indented with line two or later by
extra four spaces
Raw data
{
"_id": null,
"home_page": "",
"name": "tox-ini-fmt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Bern\u00e1t G\u00e1bor <gaborjbernat@gmail.com>",
"keywords": "environments,isolated,testing,virtual",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/1c/d5/36596fecf348d31552fa78ab2d04e031e6b507d983165b61038b73f536f0/tox_ini_fmt-1.3.0.tar.gz",
"platform": null,
"description": "# tox-ini-fmt\n\n[](https://pypi.org/project/tox-ini-fmt)\n[](https://pypi.org/project/tox-ini-fmt)\n[](https://pypi.org/project/tox-ini-fmt)\n[](https://pypistats.org/packages/tox-ini-fmt)\n[](https://opensource.org/licenses/MIT)\n\n[](https://codecov.io/gh/pypa/virtualenv)\n[](https://github.com/psf/black)\n\napply a consistent format to `tox.ini` files\n\n## installation\n\n`pip install tox-ini-fmt`\n\n## as a pre-commit hook\n\nSee [pre-commit](https://github.com/pre-commit/pre-commit) for instructions\n\nSample `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/tox-dev/tox-ini-fmt\n rev: \"1.1.0\"\n hooks:\n - id: tox-ini-fmt\n args: [\"-p\", \"fix_lint,type\"]\n```\n\n## cli\n\nConsult the help for the latest usage:\n\n```console\n$ tox-ini-fmt --help\nusage: tox-ini-fmt [-h] [-s] [-p toxenv] tox_ini\n\npositional arguments:\n tox_ini tox ini file to format\n\noptional arguments:\n -h, --help show this help message and exit\n -s, --stdout print the formatted text to the stdout (instead of update in-place)\n -p toxenv tox environments that pin to the start of the envlist (comma separated)\n```\n\n## what does it do?\n\n### It does not\n\n- Format any other section beside `tox`/`testenv:*` (other than put this sections to the end of the file)\n\n### General\n\n- `boolean` fields are normalized to `true` or `false`\n- all fields are stripped of white space on both end\n- values that contain a list are split one value per line (PR/merge friendly)\n- indent multi-line values by four spaces, and start on new line\n- substitutions within multi-line (excluding `commands`) are moved to the start of the list (order kept)\n\n### Ordering of sections\n\nApplies the following section order:\n\n1. `tox`\n2. `testenv`\n3. `testenv:*` - `py`/`pypy` envs are ordered in decreasing order by python version, then apply the order defined within\n `envlist` part of `tox` section, you can pin tox elements to the start by using the `-p` flag\n4. any other section defined within the file\n\n### `tox` section\n\nOrder by:\n\n1. `envlist` - multi-line, start with `py` envs in decreasing python order, then same with `pypy`, then everything else\n2. `isolated_build` - `boolean` field\n3. `skipsdist` - `boolean` field\n4. `skip_missing_interpreters` - `boolean` field\n5. `minversion`\n\n### `testenv` section\n\nOrder by:\n\n1. `description`\n2. `passenv` - multi-line, one environment name to pass per line, sorted by name\n3. `setenv` - multi-line, one environment name-value to set per line in format of `key=value`, sorted by key+value\n4. `basepython`\n5. `skip_install` - `boolean` field\n6. `usedevelop` - `boolean` field\n7. `deps` - multi-line, order by package name (but keep dependencies with package names separate at end), normalize\n format to remove extra spaces\n8. `extras` - multi-line, one extra env per line\n9. `parallel_show_output` - `boolean` field\n10. `commands` - one command per line, commands that wrap over multiple lines are indented with line two or later by\n extra four spaces\n",
"bugtrack_url": null,
"license": "",
"summary": "tox is a generic virtualenv management and test command line tool",
"version": "1.3.0",
"split_keywords": [
"environments",
"isolated",
"testing",
"virtual"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1f38a97a150e99a35827fe44ed49f65ca68029abc17ad4b28da6467b944169f",
"md5": "e4c8f43a0e7a1cbfac26118943bfe338",
"sha256": "75924c780fd675baec6d95be2b172ff0a11f421a5d9b67dc9a7c31e733f68ba7"
},
"downloads": -1,
"filename": "tox_ini_fmt-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4c8f43a0e7a1cbfac26118943bfe338",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13283,
"upload_time": "2023-04-07T05:33:18",
"upload_time_iso_8601": "2023-04-07T05:33:18.451207Z",
"url": "https://files.pythonhosted.org/packages/c1/f3/8a97a150e99a35827fe44ed49f65ca68029abc17ad4b28da6467b944169f/tox_ini_fmt-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1cd536596fecf348d31552fa78ab2d04e031e6b507d983165b61038b73f536f0",
"md5": "0b13d836856635a0578e30913f7b70f5",
"sha256": "60f79b3c884f5239ed2b794f2a48e4c86cc51bb7786e7ce15536d45fb337d6d4"
},
"downloads": -1,
"filename": "tox_ini_fmt-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0b13d836856635a0578e30913f7b70f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15364,
"upload_time": "2023-04-07T05:33:20",
"upload_time_iso_8601": "2023-04-07T05:33:20.095505Z",
"url": "https://files.pythonhosted.org/packages/1c/d5/36596fecf348d31552fa78ab2d04e031e6b507d983165b61038b73f536f0/tox_ini_fmt-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 05:33:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "tox-ini-fmt"
}
