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.8 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.4.0.tar.gz (126.8 kB view details)

Uploaded Source

Built Distribution

gidgethub-5.4.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gidgethub-5.4.0.tar.gz
Algorithm Hash digest
SHA256 7470d7723d7c1743471a2d62e79c8752fba12b1c0972e4bad57252338a501dbd
MD5 df773ad2446b130aa7feb2a1b6e3f0c8
BLAKE2b-256 35d46374d7a1d276ec23f5bc71a2571d36824cd121693cc2eaefa04484c02551

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gidgethub-5.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 522bd3a846a315c3163925a840930c4c9a0d685d5853afe852fd589cb472daf5
MD5 d6ca13451b38460e2d41f95378e3f804
BLAKE2b-256 7048847be03638905119b9310d15057d18f923c0ec5c846381d2fa2ccc1b7c54

See more details on using hashes here.

Supported by

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