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

Uploaded Source

Built Distribution

gidgethub-4.1.0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gidgethub-4.1.0.tar.gz
Algorithm Hash digest
SHA256 95674e830110e9d9a0d01ee51a5d74fa28cffa4ba62376ab8b7f2303cfb5369b
MD5 aefe72321f9e4e48942afc4a658268b0
BLAKE2b-256 3bc0f79cf5ba4dc54c427cbe38aa60bd5678b185329e2ce40b343102da034368

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for gidgethub-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f87910ddf17147c6c9f644848d6584680202f816b2dd7113cab6269369051aea
MD5 122185b446d1f22f058d6577a2b2eb56
BLAKE2b-256 be1ab327483fa839e735677de4a5d879bb7a1663b878f52dd951902f1d458d07

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