https://github.com/tox-dev/tox-extra
Tox plugin which adds few extra checks like assuring that git does not report dirty
https://github.com/tox-dev/tox-extra
hacktoberfest pep-621 tox-plugin tox4-plugin
Last synced: about 1 month ago
JSON representation
Tox plugin which adds few extra checks like assuring that git does not report dirty
- Host: GitHub
- URL: https://github.com/tox-dev/tox-extra
- Owner: tox-dev
- License: mit
- Created: 2021-03-16T15:00:45.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T16:44:46.000Z (about 1 month ago)
- Last Synced: 2025-04-28T17:46:36.284Z (about 1 month ago)
- Topics: hacktoberfest, pep-621, tox-plugin, tox4-plugin
- Language: Python
- Homepage:
- Size: 116 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tox-extra
This [tox plugin](https://github.com/topics/tox-plugin) adds a few extra checks
like:
- [tox-extra](#tox-extra)
- [Checks Git Dirty Status](#checks-git-dirty-status)
- [Checks system dependencies using bindep](#checks-system-dependencies-using-bindep)
## Checks Git Dirty Status
It ensures exit code 1 if git reports dirty or untracked files _after_ the run.
Usage example:
```shell
$ tox -e py
...
ERROR: Git reported dirty status. Git should never report dirty status at the end of testing, regardless if status is passed, failed or aborted.
On branch devel
Your branch is up to date with 'origin/devel'.
Untracked files:
(use "git add ..." to include in what will be committed)
some-untracked.txt
nothing added to commit but untracked files present (use "git add" to track)
__________________________________________ summary ___________________________________________
ERROR: py: failed
```
The goal of this plugin is to help developers be aware of files modified by tests
or untracked files before they commit the code. This plugin also does not take into
consideration the global `.gitignore`, something that can make git miss reporting
some untracked files, the goal being to assure that when a new developer clones and
runs the tests they do not endup with an unexpected git status.
If you have any cases where you expect to have git report dirty, please
add `--allow-dirty` to the command call to disable this check.
## Checks system dependencies using bindep
If a `bindep.txt` config file is found, tox will run `bindep [profiles]` to
check if dependencies, including test ones, are present. There is no need to
install bindep your self.
This plugin will add the following list of bindep profiles:
- `test` is always added as tox itself is a test tool
- exact tox env name
- tox env name itself split by `-'
- `pythonX.Y` and `pyXY` based on which python current tox env will use
This should allow developers to modify their `bindep.txt` file to include
system dependencies specific to a single tox environment if they wish.
To disable bindep feature, you can define `TOX_EXTRA_BINDEP=0` in your
environment.