Skip to main content

An async GitHub API library

Project description

An asynchronous GitHub API library.

Development status

https://travis-ci.org/brettcannon/gidgethub.svg?branch=master 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-3.2.0.tar.gz (109.2 kB view details)

Uploaded Source

Built Distribution

gidgethub-3.2.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gidgethub-3.2.0.tar.gz
Algorithm Hash digest
SHA256 8f4b69063a256994d38243cc0eba4e1453017b5b8b04a173216d02d47ffc3989
MD5 9bba28d09a00738e81a8413aeefd07b4
BLAKE2b-256 9a98e2883d052a04739b47ad0109ac02fecfbcbc1fb6ccf87c67fd208884abc7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gidgethub-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for gidgethub-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f1a4cd8ea73ee44245fa510f01ce602cd328745bf83a3342d08d168a604f4c6
MD5 d2e14f32f257b7f7c0269f3971a6dc7a
BLAKE2b-256 616ea82bfec472e3a7133feb61d81a2dd6557a7cfcd85886396cd33655ec10a1

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