GitHubKit: GitHub SDK for Python

0.15.3 · active · verified Sat Apr 11

GitHubKit is a comprehensive, type-hinted SDK for interacting with the GitHub REST API and GraphQL API, and for parsing webhooks. It supports the latest GitHub API versions and provides a consistent interface for various GitHub features. The current version is 0.15.3, with frequent releases often driven by updates to GitHub's OpenAPI specification.

Warnings

breaking In `v0.15.0`, the default GitHub REST API version was updated to `2026-03-10`. This might introduce breaking changes to existing code if your application relied on older API behaviors or response structures for endpoints that changed in the new API version. Review GitHub's API changelog for this version.
Fix: Review your API calls and ensure compatibility with GitHub REST API version 2026-03-10. If necessary, you can explicitly set an older API version when initializing the client, e.g., `GitHub(token, api_version='2022-11-28')`.
gotcha It is highly recommended to reuse `GitHub` or `AppGitHub` client instances rather than creating a new one for each request. Creating multiple clients can lead to performance issues due to re-establishing connections and not utilizing connection pooling efficiently.
Fix: Initialize your `GitHub` client once at the application startup or within a global scope (e.g., as a global variable, dependency injection, or FastAPI `Depends`) and pass the same instance to all functions or methods that need to interact with the GitHub API.
gotcha When handling GitHub webhooks, failing to verify the `X-Hub-Signature-256` header (or `X-GitHub-Signature`) can lead to security vulnerabilities, allowing attackers to send forged payloads to your endpoint.
Fix: Always use `githubkit.webhooks.parse_webhook(payload, signature, secret)` and ensure you pass the correct webhook secret configured in your GitHub App or repository settings. The `parse_webhook` function handles the signature verification automatically and raises an error if it fails.
gotcha GitHub API requests are subject to rate limiting. Not handling `githubkit.exception.RateLimitError` or checking `response.headers['x-ratelimit-remaining']` can lead to your application being temporarily blocked.
Fix: Implement robust error handling for `githubkit.exception.RateLimitError`. Consider using a retry mechanism with exponential backoff, or consult the `x-ratelimit-reset` header to know when the rate limit will reset and pause requests accordingly.

Install

pip install githubkit Install stable version

Imports

GitHub
```
from githubkit import GitHub
```
Main client for authenticated GitHub API access (tokens, personal access tokens).
AppGitHub
```
from githubkit import AppGitHub
```
Client for GitHub App authentication.
parse_webhook
```
from githubkit.webhooks import parse_webhook
```
Function to parse GitHub webhook payloads and verify signatures.
GitHubException
```
from githubkit.exception import GitHubException
```
Base exception for GitHub API errors.

Quickstart

This quickstart demonstrates how to initialize the GitHubKit client with a Personal Access Token (PAT) and make a simple REST API call to fetch the authenticated user's details and their repositories. Ensure `GITHUB_TOKEN` is set in your environment.

import os
from githubkit import GitHub

github_token = os.environ.get('GITHUB_TOKEN', '')

if not github_token:
    print("Error: GITHUB_TOKEN environment variable not set.")
else:
    github = GitHub(github_token)
    try:
        # Get information about the authenticated user
        user = github.rest.users.get_authenticated_user()
        print(f"Hello, {user.data.login} (ID: {user.data.id})!")

        # Example: list repositories for the authenticated user
        repos = github.rest.repos.list_for_authenticated_user()
        print(f"You have {len(repos.data)} repositories.")

    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →