Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigmavirus24/github3.py
Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.
https://github.com/sigmavirus24/github3.py
github github-api python python36 python37 python38 python39 rest rest-api rest-client
Last synced: about 2 months ago
JSON representation
Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.
- Host: GitHub
- URL: https://github.com/sigmavirus24/github3.py
- Owner: sigmavirus24
- License: bsd-3-clause
- Created: 2012-03-13T19:58:53.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T21:41:11.000Z (5 months ago)
- Last Synced: 2024-04-16T01:29:56.864Z (5 months ago)
- Topics: github, github-api, python, python36, python37, python38, python39, rest, rest-api, rest-client
- Language: Python
- Homepage: https://github3.readthedocs.io
- Size: 74 MB
- Stars: 1,186
- Watchers: 32
- Forks: 395
- Open Issues: 59
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.rst
Awesome Lists containing this project
- stars - sigmavirus24/github3.py
- awesome - sigmavirus24/github3.py - Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+. (Python)
- starred-awesome - github3.py - Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 2.7, 3.4, 3.5, and 3.6 (Python)
README
.. 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 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.
.. _github3.py: http://stackoverflow.com/questions/tagged/github3.py
.. _email: mailto:[email protected]