Skip to content

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

License

Notifications You must be signed in to change notification settings

sigmavirus24/github3.py

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

Contributing

Please read the CONTRIBUTING document.

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.

Build status

You can find build statuses for different environments.

License

Modified BSD license

Examples

See the docs for more examples.

Testing

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

make tests

Author

Ian Stapleton Cordasco (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 use Github discussions (https://github.com/sigmavirus24/github3.py/discussions).
  • You may also contact (via email) the author directly with questions/suggestions/comments or if you wish to include sensitive data.