chore: tweak configs to match pyramid #89
Conversation
Suppress warnings where possible (some still emitted by 'build', but they match those from Pyramid).
tseaver
requested review from
fschulze,
mcdonc,
mmerickel and
digitalresistor
| $ python3 -m venv env | ||
| $ env/bin/pip install -e .[docs,testing] |
There was a problem hiding this comment.
I wouldn't install a local copy. I don't during dev. tox will install and run tests in their own virtualenvs across the supported versions of Python.
There was a problem hiding this comment.
Lots of development requires being able to do things like set breakpoints in code to examine state: this environment is intended to support that, not automated testing.
There was a problem hiding this comment.
Even within a tox run you can set breakpoints and the like, and now you are actually testing what the end result will be (a wheel) vs potential other things that are in the python path because of the directory you are in. I know we switched to src directory on purpose, but tox makes it cleaner and easier to not accidentally be testing/validating something that is not the same as what will be tested in CI/CD.
|
|
||
| 4. Create a branch for local development:: | ||
|
|
||
| $ git checkout -b name-of-your-bugfix-or-feature |
There was a problem hiding this comment.
| $ git checkout -b name-of-your-bugfix-or-feature | |
| $ git switch -c name-of-your-bugfix-or-feature |
Using git checkout is not recommend by git anymore due to confusion related to what it means to do a checkout.
There was a problem hiding this comment.
Can you point me to a reference for that recommendation? The basic branching and merging chapter of the official git book still uses checkout -b.
There was a problem hiding this comment.
https://linuxhandbook.com/git-switch-checkout/
https://git-scm.com/docs/git-switch
git switch was explicitly added to stop confusion around what "checkout" does since checkout was overloaded.
|
|
||
| To run a subset of tests:: | ||
|
|
||
| $ env/bin/py.test tests.test_venusian |
There was a problem hiding this comment.
tox -e py38 -- tests.test_venusian
Will do the same thing, and doesn't require a local installation that may be out of date, and will cause tox to update the right versions of dependencies and the like.
There was a problem hiding this comment.
See above: I don't use tox this way, but always have a separate virtual env for actual development. The fact that tox does not install a development copy is the entire point of having a virtual env which does.
Suppress warnings where possible (some still emitted by 'build', but they match those from Pyramid).
Discovered while chasing down local tox failures on my machine.