Need help with github3.py?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sigmavirus24
1.0K Stars 383 Forks Other 3.2K Commits 82 Opened issues

Description

Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.

Services available

!
?

Need anything else?

Contributors list

.. 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.

Installation

::

$ pip install github3.py

Dependencies

  • requests_
  • uritemplate_

.. _requests: https://github.com/kennethreitz/requests .. _uritemplate: https://github.com/sigmavirus24/uritemplate

Contributing

Please read the

CONTRIBUTING
_ document.

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

Testing ~~~~~~~

You can run either

pip install -r dev-requirements.txt
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

master
build statuses for different environments.
  • Github_
  • appveyor_

.. _Github: https://github.com/sigmavirus24/github3.py/actions .. _appveyor: https://ci.appveyor.com/project/sigmavirus24/github3-py/branch/master

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 [email protected]
  • 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:[email protected]

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.