Project: github3-py

.. 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.7+ or pypy3. For older versions, please use version 1.3.0.

Installation

::

$ pip install github3.py

Dependencies

• requests_
• uritemplate_
• python-dateutil_
• PyJWT_

.. _requests: https://github.com/kennethreitz/requests .. _uritemplate: https://github.com/sigmavirus24/uritemplate .. _python-dateutil: https://github.com/dateutil/dateutil .. _PyJWT: https://github.com/jpadilla/pyjwt

Contributing

Please read the CONTRIBUTING_ document.

.. _CONTRIBUTING: https://github.com/sigmavirus24/github3.py/blob/master/CONTRIBUTING.rst

Testing

You can run ``pip install -e .[dev]`` to 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_
- coverage_ by Ned Batchelder

.. _betamax: https://github.com/sigmavirus24/betamax
.. _coverage: http://nedbatchelder.com/code/coverage/

Build status

You can find build statuses for different environments.

• Github_

.. _Github: https://github.com/sigmavirus24/github3.py/actions

License

Modified BSD license_

.. _license: https://github.com/sigmavirus24/github3.py/blob/master/LICENSE

Examples

See the docs_ for more examples.

.. _docs: https://github3.readthedocs.io/en/latest/index.html#more-examples

Testing

Install the dependencies from requirements.txt e.g.:

::

    make tests

Author
------

Ian Stapleton Cordasco (sigmavirus24_)

.. _sigmavirus24: https://github.com/sigmavirus24

Contact Options
---------------

- Feel free to use the `github3.py`_ tag on Stack Overflow for any questions
  you may have.
- If you dislike Stack Overflow, it is preferred that you send an email to
  github3.py@librelist.com .
- You may also contact (via email_) the author directly with
  questions/suggestions/comments or if you wish to include sensitive data.

.. _github3.py: http://stackoverflow.com/questions/tagged/github3.py
.. _email: mailto:graffatcolmingov@gmail.com