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.0.0.tar.gz (122.7 kB view details)

Uploaded Source

Built Distribution

gidgethub-5.0.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gidgethub-5.0.0.tar.gz
Algorithm Hash digest
SHA256 a4a8d8b1ab629757b557d3bcb98a5a77790a3d00b320f5f881a1754cf0e21086
MD5 3263cf61a887e62191e47b3307a9b5ea
BLAKE2b-256 29ef871f92f54b919df3d83ecc89d6968deac457846b31220bf1a58a601cd369

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for gidgethub-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8aea58a54889e3490804be917d1d5cfec4e81458cd85b34974834f96e5e697d3
MD5 c3f209eae9aa0163fdd59c5027bac121
BLAKE2b-256 f733d9c8684eb4f83bcafeb452e70c94f76968c6a55489bee8c77ad8fdee0b96

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