1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
|
============
Contributing
============
Test simple changes
===================
Requests-OAuthlib is using `tox`_ as main test tool.
It helps creating the required virtualenv for your python version.
For example, if you have installed Python3.7:
.. sourcecode:: bash
$ tox -e py37
Validate documentation changes
==============================
Tox contains also a build method to generate documentation locally.
.. sourcecode:: bash
$ tox -e docs,readme
Then open the HTML page in `_build/html/index.html`
Verify all pythons versions
===========================
Requests-OAuthlib supports multiple versions of Python.
You can test all Python versions conveniently using `tox`_.
.. sourcecode:: bash
$ tox
In order to run successfully, you will need all versions of Python installed. We recommend using `pyenv`_ to install those Python versions.
.. sourcecode:: bash
$ pyenv install 2.7.18
$ pyenv install 3.4.10
$ pyenv install 3.5.10
$ pyenv install 3.6.14
$ pyenv install 3.7.11
$ pyenv install pypy2.7-7.1.1
$ pyenv install pypy3.6-7.1.1
.. _`tox`: https://tox.readthedocs.io/en/latest/install.html
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/installation/
.. _`pyenv`: https://github.com/pyenv/pyenv
|