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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gidgethub-5.0.1.tar.gz
Algorithm Hash digest
SHA256 3efbd6998600254ec7a2869318bd3ffde38edc3a0d37be0c14bc46b45947b682
MD5 4ab61e5afd4b2fc5e58140e86c5cadb6
BLAKE2b-256 0c0bb36b7e1f2daa9399c2277b83a8a6a4eacadfdb13675c60385f58ddab494e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gidgethub-5.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67245e93eb0918b37df038148af675df43b62e832c529d7f859f6b90d9f3e70d
MD5 ada681674eb9ca6d36c07fc6929e6899
BLAKE2b-256 499362966e12f713e19cf1ff5f18d6a9652a3ef447d433cf8299ebf387c229a3

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