https://github.com/gidgethub/gidgethub

An async GitHub API library for Python
https://github.com/gidgethub/gidgethub

aiohttp async github httpx python sans-io tornado treq twisted

Last synced: 2 days ago
JSON representation

An async GitHub API library for Python

• Host: GitHub
• URL: https://github.com/gidgethub/gidgethub
• Owner: gidgethub
• License: apache-2.0
• Created: 2017-01-21T21:08:59.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-24T22:31:19.000Z (3 months ago)
• Last Synced: 2024-05-19T07:27:12.607Z (about 2 months ago)
• Topics: aiohttp, async, github, httpx, python, sans-io, tornado, treq, twisted
• Language: Python
• Homepage: https://gidgethub.readthedocs.io
• Size: 465 KB
• Stars: 358
• Watchers: 10
• Forks: 55
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• awesome-stars - gidgethub/gidgethub - An async GitHub API library for Python (Python)
• awesome-stars - gidgethub/gidgethub - An async GitHub API library for Python (Python)

README

        
gidgethub

=========

An asynchronous `GitHub API `_ library.

Development status

------------------

.. image:: https://github.com/brettcannon/gidgethub/workflows/CI/badge.svg?event=push

    :target: https://github.com/brettcannon/gidgethub/actions

.. image:: https://codecov.io/gh/brettcannon/gidgethub/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/brettcannon/gidgethub

.. image:: https://readthedocs.org/projects/gidgethub/badge/?version=latest

    :target: http://gidgethub.readthedocs.io/en/latest/

    :alt: Documentation Status

Installation

------------

Gidgethub is `available on PyPI `_.

::

  python3 -m pip install gidgethub

Gidgethub requires Python version 3.7 and up.

Goals

-----

The key goal is to provide a base library for the

`GitHub API `_ which performs no I/O of its own (a

`sans-I/O `_ library). This allows users to

choose whatever HTTP library they prefer while parceling out GitHub-specific

details to this library. This base library is then built upon to provide an

abstract base class to a cleaner API to work with. Finally, implementations of

the abstract base class are provided for asynchronous HTTP libraries for

immediate usage.

Alternative libraries

---------------------

If you think you want a different approach to the GitHub API,

`GitHub maintains a list of libraries `_.

*Aside*: what's with the name?

------------------------------

I couldn't think of a good name that was somehow a play on "GitHub" or somehow

tied into `Monty Python `_. And so I decided to play

off of GitHub's `octocat `_ mascot and use my own

cat's name, Gidget, in some way. Since "Gidget" somewhat sounds like

"git", I decided to go with "gidgethub".

Changelog

---------

See the documentation for the `full changelog `_.