Skip to content

Installation

Tip

githubkit supports both pydantic v1 and v2, but pydantic v2 is recommended. If you have encountered any problems with pydantic v1/v2, please file an issue.

Basic Installation

poetry add githubkit
pdm add githubkit
uv add githubkit
pip install githubkit

Extra Dependencies

If you want to auth as github app, you should install auth-app extra dependencies:

poetry add githubkit[auth-app]
pdm add githubkit[auth-app]
uv add githubkit[auth-app]
pip install githubkit[auth-app]

If you want to mix sync and async calls in oauth device callback, you should install auth-oauth-device extra dependencies:

poetry add githubkit[auth-oauth-device]
pdm add githubkit[auth-oauth-device]
uv add githubkit[auth-oauth-device]
pip install githubkit[auth-oauth-device]

Full Installation

You can install fully featured githubkit with all extra dependencies:

poetry add githubkit[all]
pdm add githubkit[all]
uv add githubkit[all]
pip install githubkit[all]