Githubkit

<!-- markdownlint-disable MD041 --> <div align="center">

</div> <p align="center"> <a href="https://raw.githubusercontent.com/yanyongyu/githubkit/master/LICENSE"> <img src="https://img.shields.io/github/license/yanyongyu/githubkit" alt="license"> </a> <a href="https://pypi.python.org/pypi/githubkit"> <img src="https://img.shields.io/pypi/v/githubkit?logo=python&logoColor=edb641" alt="pypi"> </a> <img src="https://img.shields.io/badge/python-3.9+-blue?logo=python&logoColor=edb641" alt="python"> <a href="https://github.com/psf/black"> <img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black"> </a> <a href="https://github.com/Microsoft/pyright"> <img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright"> </a> <a href="https://github.com/astral-sh/ruff"> <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff"> </a> <a href="https://results.pre-commit.ci/latest/github/yanyongyu/githubkit/master"> <img src="https://results.pre-commit.ci/badge/github/yanyongyu/githubkit/master.svg" alt="pre-commit" /> </a> </p> <div align="center"> <!-- markdownlint-capture --> <!-- markdownlint-disable MD036 -->

✨ The modern, all-batteries-included GitHub SDK for Python ✨

✨ Support both sync and async calls, fully typed ✨

✨ Always up to date, like octokit ✨

<!-- markdownlint-restore --> </div> <p align="center"> <a href="https://yanyongyu.github.io/githubkit/"><b>Documentation</b></a> | <a href="https://github.com/yanyongyu/githubkit/issues"><b>Report Bug</b></a> | <a href="https://docs.github.com/"><b>GitHub Docs</b></a> </p>

githubkit aims to be an easy-to-use, fully typed, and always up-to-date GitHub SDK for Python. It is inspired by octokit.

githubkit provides several features including:

• Support both sync and async calls
• Multiple authentication ways and OAuth flow support
• Calling REST API and GraphQL easily
• REST API versioning, including GHEC
• Built-in pagination support
• Optional data validation with Pydantic, for both webhook events and REST API responses
• Built-in http cache (powered by Hishel for HTTPX) and auto retry
• Lazy loading of APIs and models
• Fully typed APIs

Getting Started

For more, see the documentation.

Installation

Install githubkit with the package manager of your choice:

pip install githubkit
# or, use poetry
poetry add githubkit
# or, use pdm
pdm add githubkit
# or, use uv
uv add githubkit

Usage

Create a Personal Access Token (PAT) and use it to create a GitHub instance:

from githubkit import GitHub

github = GitHub("<your_token_here>")

Then, enjoy githubkit now!

from githubkit import Response
from githubkit.versions.latest.models import FullRepository

resp: Response[FullRepository] = github.rest.repos.get("owner", "repo")
repo: FullRepository = resp.parsed_data
print(repo.full_name)

Development

[!TIP] Open in Codespaces (Dev Container):

See the development in the contributing guide.

Contributors

Thanks to the following people who have contributed to this project:

<a href="https://github.com/yanyongyu/githubkit/graphs/contributors"> <img src="https://contrib.rocks/image?repo=yanyongyu/githubkit&max=1000" alt="contributors" /> </a>