Skip to main content

An async GitHub API library

Project description

An asynchronous GitHub API library.

Development status

https://github.com/brettcannon/gidgethub/workflows/CI/badge.svg?event=push https://codecov.io/gh/brettcannon/gidgethub/branch/master/graph/badge.svg Documentation Status

Installation

Gidgethub is available on PyPI.

python3 -m pip install gidgethub

Gidgethub requires Python version 3.6 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gidgethub-5.2.0.tar.gz (125.7 kB view details)

Uploaded Source

Built Distribution

gidgethub-5.2.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file gidgethub-5.2.0.tar.gz.

File metadata

  • Download URL: gidgethub-5.2.0.tar.gz
  • Upload date:
  • Size: 125.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for gidgethub-5.2.0.tar.gz
Algorithm Hash digest
SHA256 c359b769194e72f984d2e328de0ee8eb81b702342b0a44dc5cebac92104ecf4b
MD5 51403257c0bc102da9c7b69b03434b1e
BLAKE2b-256 65efa715577aa865d06bf1600afb4f5192194531e15608a12c1b5218d40c656d

See more details on using hashes here.

Provenance

File details

Details for the file gidgethub-5.2.0-py3-none-any.whl.

File metadata

  • Download URL: gidgethub-5.2.0-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for gidgethub-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 390caafb3e9c6125bb9c8c9865a78d09e028f19592352d5b88e0ed881b8dea18
MD5 ec95b90e8a23d25c94a11b46d78f6804
BLAKE2b-256 d2c589a60336fd796e09bcb125bc0a044869ae21b1e795a9915e004154607dc4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page