Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.
.. image:: https://raw.github.com/sigmavirus24/github3.py/master/docs/img/gh3-logo.png
github3.py is a comprehensive, actively developed and extraordinarily stable wrapper around the GitHub API (v3).
Note: This library currently works with Python 3.6+ or pypy3. For older versions, please use version 1.3.0.
$ pip install github3.py
.. _requests: https://github.com/kennethreitz/requests .. _uritemplate: https://github.com/sigmavirus24/uritemplate
Please read the
.. _CONTRIBUTING: https://github.com/sigmavirus24/github3.py/blob/master/CONTRIBUTING.rst
You can run either
pip install -r dev-requirements.txtto install the following before testing or simply
make test-deps. It is suggested you do this in a virtual environment. These need to be installed for the tests to run.
.. _betamax: https://github.com/sigmavirus24/betamax .. _coverage: http://nedbatchelder.com/code/coverage/
Build status ~~~~~~~~~~~~
You can find
masterbuild statuses for different environments.
.. _Github: https://github.com/sigmavirus24/github3.py/actions .. _appveyor: https://ci.appveyor.com/project/sigmavirus24/github3-py/branch/master
Modified BSD license_
.. _license: https://github.com/sigmavirus24/github3.py/blob/master/LICENSE
See the docs_ for more examples.
.. _docs: https://github3.readthedocs.io/en/latest/index.html#more-examples
Install the dependencies from requirements.txt e.g.:
Ian Stapleton Cordasco (sigmavirus24_)
.. _sigmavirus24: https://github.com/sigmavirus24
github3.py_ tag on Stack Overflow for any questions you may have
.. _github3.py: http://stackoverflow.com/questions/tagged/github3.py .. _email: mailto:[email protected]