Switch out tox for nox #2857
Switch out tox for nox #2857
Conversation
It's nicer to work with especially as it uses a bog standard Python file for configuration. Its output is cleaner and it doesn't hide any magic too. Also the mypy cache has been reenabled since it speeds up pre-commit hooks significantly which makes life easier :) Hopefully this makes the initial set up process relatively painfree.
ichard26
added
skip news
| ``` | ||
|
|
||
| ### News / Changelog Requirement | ||
| You can also setup pre-commit to automatically run before committing. First, install |
There was a problem hiding this comment.
| You can also setup pre-commit to automatically run before committing. First, install | |
| You can also set up pre-commit to automatically run before committing. First, install |
| ``` | ||
|
|
||
| ### News / Changelog Requirement | ||
| You can also setup pre-commit to automatically run before committing. First, install | ||
| pre-commit similarly to nox and install the Git pre commit hook: |
There was a problem hiding this comment.
| pre-commit similarly to nox and install the Git pre commit hook: | |
| pre-commit similarly to nox and install the Git pre-commit hook: |
| - `Black` is now more awesome (#X) | ||
| ### Running tests | ||
|
|
||
| Before opening a pull request that involves code, please run the test suite to verify |
There was a problem hiding this comment.
I'm actually not sure we should recommend this. Local tests are often annoying and finicky to set up, so why not just rely on our CI?
|
|
||
| ### Style Changes | ||
| By default, the test suite is ran with coverage and parallelization enabled, but you can |
There was a problem hiding this comment.
| By default, the test suite is ran with coverage and parallelization enabled, but you can | |
| By default, the test suite is run with coverage and parallelization enabled, but you can |
| $ nox -s docs | ||
| ``` | ||
|
|
||
| If you are making many changes to docs, you may find it helpful to use the `docs-live` |
| Note that X should be your PR number, not issue number! To workout X, please use | ||
| [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This | ||
| is not perfect but saves a lot of release overhead as now the releaser does not need to | ||
| go back and workout what to add to the `CHANGES.md` for each release. |
There was a problem hiding this comment.
| Note that X should be your PR number, not issue number! To workout X, please use | |
| [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This | |
| is not perfect but saves a lot of release overhead as now the releaser does not need to | |
| go back and workout what to add to the `CHANGES.md` for each release. | |
| Note that X should be your PR number, not issue number! To work out X, please use | |
| [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This | |
| saves a lot of release overhead as now the releaser does not need to | |
| go back and work out what to add to the `CHANGES.md` for each release. |
No need to apologize here
There was a problem hiding this comment.
That said, wouldn't it be worth implementing this as a pre-commit script or GHA ? (not necessarily in this PR) "If the diff in CHANGES.md is a single added line, then add (#PR) at the end."
(depending on if you decide on a different path on #2766)
| @@ -77,4 +153,9 @@ any large feature, first open an issue for us to discuss the idea first. | |||
| ## Finally | |||
|
|
|||
| Thanks again for your interest in improving the project! You're taking action when most | |||
| people decide to sit and watch. | |||
| people decide to sit and watch. If you ever need help feel free to ask on the relevant | |||
There was a problem hiding this comment.
| people decide to sit and watch. If you ever need help feel free to ask on the relevant | |
| people decide to sit and watch. If you ever need help, feel free to ask on the relevant |
| Most development tasks are automated by [nox][nox] which automatically creates virtual | ||
| environments and running the right commands. You'll most likely run the test suite, |
There was a problem hiding this comment.
| Most development tasks are automated by [nox][nox] which automatically creates virtual | |
| environments and running the right commands. You'll most likely run the test suite, | |
| Most development tasks are automated by [nox][nox], which automatically creates virtual | |
| environments and runs the right commands. You'll most likely run the test suite, |
| (.venv)$ pip install -r test_requirements.txt | ||
| (.venv)$ pip install -e .[d] | ||
| (.venv)$ pre-commit install | ||
| (.venv)$ pip install -e .[d,jupyter] |
There was a problem hiding this comment.
What about creating a requirements.txt file that would contain -e .[d,jupyter], so that new devs wouldn't have to track the extras ?
Also, if we don't do that, then:
| (.venv)$ pip install -e .[d,jupyter] | |
| (.venv)$ pip install -e '.[d,jupyter]' |
The simple quotes are much more likely to work, bash/zsh will likely try to do some completion magic otherwise.
| Note that X should be your PR number, not issue number! To workout X, please use | ||
| [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This | ||
| is not perfect but saves a lot of release overhead as now the releaser does not need to | ||
| go back and workout what to add to the `CHANGES.md` for each release. |
There was a problem hiding this comment.
That said, wouldn't it be worth implementing this as a pre-commit script or GHA ? (not necessarily in this PR) "If the diff in CHANGES.md is a single added line, then add (#PR) at the end."
(depending on if you decide on a different path on #2766)
|
I'm rewriting the developer getting started document so I'll rewrite this PR too. This is pretty stale now. |
Description
Towards #2238
It's nicer to work with especially as it uses a bog standard Python file
for configuration. Its output is cleaner and it doesn't hide any magic
too.
Also the mypy cache has been reenabled since it speeds up pre-commit
hooks significantly which makes life easier :)
Hopefully this makes the initial set up process relatively painfree.
Preview: https://black.readthedocs.io/en/hello-nox/contributing/the_basics.html
Checklist - did you ...