mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-22 17:46:57 +03:00
Update contributing docs about using tox and sync tox pytest cmd with travis (#744)
* Update pytest command run by tox to match the command used by travis. Updated README contributing section with info about using tox to run tests. * Uppercase 'Graphene'
This commit is contained in:
parent
a7168ffc6e
commit
f13e54b4a4
18
README.md
18
README.md
|
@ -79,18 +79,32 @@ After cloning this repo, ensure dependencies are installed by running:
|
|||
pip install -e ".[test]"
|
||||
```
|
||||
|
||||
After developing, the full test suite can be evaluated by running:
|
||||
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
|
||||
|
||||
```sh
|
||||
py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode
|
||||
py.test PATH/TO/MY/DIR/test_test.py # Single file
|
||||
py.test PATH/TO/MY/DIR/ # All tests in directory
|
||||
```
|
||||
|
||||
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
|
||||
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
|
||||
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
|
||||
|
||||
You can also run the benchmarks with:
|
||||
|
||||
```sh
|
||||
py.test graphene --benchmark-only
|
||||
```
|
||||
|
||||
Graphene supports several versions of Python. To make sure that changes do not break compatibility with any of those versions, we use `tox` to create virtualenvs for each python version and run tests with that version. To run against all python versions defined in the `tox.ini` config file, just run:
|
||||
```sh
|
||||
tox
|
||||
```
|
||||
If you wish to run against a specific version defined in the `tox.ini` file:
|
||||
```sh
|
||||
tox -e py36
|
||||
```
|
||||
Tox can only use whatever versions of python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful!
|
||||
|
||||
### Documentation
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
import os
|
||||
|
||||
import sphinx_graphene_theme
|
||||
|
||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||
|
|
Loading…
Reference in New Issue
Block a user