Skip to content

Commit b72dfa8

Browse files
dan98765jkimbo
authored andcommitted
Update README Contributing section to encourage use of virtualenv (#765)
1 parent 12ee52a commit b72dfa8

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,11 @@ If you want to learn even more, you can also check the following [examples](exam
7373

7474
## Contributing
7575

76-
After cloning this repo, ensure dependencies are installed by running:
76+
After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
7777

7878
```sh
79+
virtualenv venv
80+
source venv/bin/activate
7981
pip install -e ".[test]"
8082
```
8183

@@ -87,7 +89,7 @@ py.test PATH/TO/MY/DIR/ # All tests in directory
8789
```
8890

8991
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
90-
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
92+
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
9193
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
9294

9395
You can also run the benchmarks with:
@@ -96,15 +98,15 @@ You can also run the benchmarks with:
9698
py.test graphene --benchmark-only
9799
```
98100

99-
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:
101+
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:
100102
```sh
101103
tox
102104
```
103-
If you wish to run against a specific version defined in the `tox.ini` file:
105+
If you wish to run against a specific version defined in the `tox.ini` file:
104106
```sh
105107
tox -e py36
106108
```
107-
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!
109+
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!
108110

109111
### Documentation
110112

0 commit comments

Comments
 (0)