Lukasa / gidgethub

An async GitHub API library for Python

Home Page:https://gidgethub.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gidgethub

A sans-I/O GitHub API library

Build Status codecov Documentation Status

Installation

No wheels have been uploaded to PyPI yet. Until then, you can install from source, e.g. python3 -m pip install . or python3 -m pip install ".[aiohttp].

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 as a theme and use my cat's name, Gidget, as part of the name. Since "Gidget" somewhat sounds like "git", I decided to go with "gidgethub".

About

An async GitHub API library for Python

https://gidgethub.readthedocs.io

License:Apache License 2.0


Languages

Language:Python 100.0%