Repository files navigation

Documentation |Report Bug |GitHub Docs

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

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 withPydantic, for both webhook events and REST API responses
• Built-in http cache (powered byHishel for HTTPX) and auto retry
• Lazy loading of APIs and models
• Fully typed APIs

For more, see thedocumentation.

Install githubkit with the package manager of your choice:

pip install githubkit# or, use poetrypoetry add githubkit# or, use pdmpdm add githubkit# or, use uvuv add githubkit

Create aPersonal Access Token (PAT) and use it to create aGitHub instance:

fromgithubkitimportGitHubgithub=GitHub("<your_token_here>")

Then, enjoy githubkit now!

fromgithubkitimportResponsefromgithubkit.versions.latest.modelsimportFullRepositoryresp:Response[FullRepository]=github.rest.repos.get("owner","repo")repo:FullRepository=resp.parsed_dataprint(repo.full_name)

See thedevelopment in the contributing guide.

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