Skip to content

Commit

Permalink
Initial version of contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanHuot authored and jtroussard committed Dec 6, 2021
1 parent 59b3b1c commit 2944df6
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,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

1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Getting Started:
examples/examples

api
contributing



Expand Down

0 comments on commit 2944df6

Please sign in to comment.