File tree Expand file tree Collapse file tree 2 files changed +55
-0
lines changed
Expand file tree Collapse file tree 2 files changed +55
-0
lines changed Original file line number Diff line number Diff line change 1+ ============
2+ Contributing
3+ ============
4+
5+ Test simple changes
6+ ===================
7+
8+ Requests-OAuthlib is using `tox `_ as main test tool.
9+ It helps creating the required virtualenv for your python version.
10+ For example, if you have installed Python3.7:
11+
12+ .. sourcecode :: bash
13+
14+ $ tox -e py37
15+
16+
17+ Validate documentation changes
18+ ==============================
19+
20+ Tox contains also a build method to generate documentation locally.
21+
22+ .. sourcecode :: bash
23+
24+ $ tox -e docs,readme
25+
26+ Then open the HTML page in `_build/html/index.html `
27+
28+
29+ Verify all pythons versions
30+ ===========================
31+
32+ Requests-OAuthlib supports multiple versions of Python.
33+ You can test all Python versions conveniently using `tox `_.
34+
35+ .. sourcecode :: bash
36+
37+ $ tox
38+
39+ In order to run successfully, you will need all versions of Python installed. We recommend using `pyenv `_ to install those Python versions.
40+
41+ .. sourcecode :: bash
42+
43+ $ pyenv install 2.7.18
44+ $ pyenv install 3.4.10
45+ $ pyenv install 3.5.10
46+ $ pyenv install 3.6.14
47+ $ pyenv install 3.7.11
48+ $ pyenv install pypy2.7-7.1.1
49+ $ pyenv install pypy3.6-7.1.1
50+
51+ .. _`tox` : https://tox.readthedocs.io/en/latest/install.html
52+ .. _`virtualenv` : https://virtualenv.pypa.io/en/latest/installation/
53+ .. _`pyenv` : https://github.com/pyenv/pyenv
54+
Original file line number Diff line number Diff line change @@ -72,6 +72,7 @@ Getting Started:
7272 examples/examples
7373
7474 api
75+ contributing
7576
7677
7778
You can’t perform that action at this time.
0 commit comments