aiogithubapi
Asynchronous Python client for the GitHub API
This is not a full client for the API (Have you seen it, it's huge), and will probably never be. Things are added when needed or requested.
If something you need is missing please raise a feature request to have it added or create a PR 🎉.
For examples on how to use it see the tests directory.
Install
python3 -m pip install aiogithubapi
Project transition
Note: This project is currently in a transition phase.
In August 2021 a new API interface was introduced (in #42). With that addition, all parts of the old interface are now considered deprecated. Which includes:
- The
aiogithubapi.commonmodule - The
aiogithubapi.legacymodule - The
aiogithubapi.objectsmodule - All classes starting with
AIOGitHub - The
async_call_apifunction in theaiogithubapi/helpers.pyfile - The
GitHubDeviceclass inaiogithubapi, replaced withGitHubDeviceAPI - The
GitHubclass inaiogithubapi, replaced withGitHubAPI
Warning: The deprecated code will be removed in a future release. Please migrate to the new API interface.
Contribute
All contributions are welcome!
- Fork the repository
- Clone the repository locally and open the devcontainer or use GitHub codespaces
- Do your changes
- Lint the files with
scripts/lint - Ensure all tests pass with
scripts/test - Ensure 100% coverage with
scripts/coverage - Commit your work, and push it to GitHub
- Create a PR against the
mainbranch
Versioning
This project follows Semantic Versioning.
Early releases used semver (0.1.0–2.0.0), followed by a period of calendar versioning (21.1.0–25.5.0). Starting with 26.0.0, the project returns to semver — using 26.x.x as the starting point to stay above the last calver release and avoid confusing package managers.
Version bumps are determined automatically by PR labels:
breaking-change→ majorfeature/enhancement→ minor- All other changes → patch
Release
Releases are automated via GitHub Actions. The flow works as follows:
- PRs are merged to
mainwith appropriate labels - On every merge, release-drafter automatically maintains a draft GitHub Release with categorized changelog entries built from PR titles and authors
- Changelog entries are grouped into: Breaking changes, New features, Enhancements, Bug fixes, Maintenance, Documentation, and Dependencies
- A maintainer reviews the draft and publishes the release via the GitHub Releases UI
- Publishing the GitHub Release for a tag (creating or selecting the tag in the UI) triggers the release workflow, which stamps the version into
pyproject.toml, builds the package, and publishes it to PyPI via OIDC trusted publishing
Release files for aiogithubapi 26.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aiogithubapi-26.0.0.tar.gz | 37.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aiogithubapi-26.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 110.2 kB
Release files / aiogithubapi-26.0.0.tar.gz
| Download URL | aiogithubapi-26.0.0.tar.gz |
|---|---|
| Size | 37.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71ee97ebb242378535551ede80605384d1d3536b83e68dae938ce201d06dac33
|
|
BLAKE2b-256 checksum How to use checksums |
414c1319dc5f7772f2ad960bd84d47d972a64aa596b6cdd966956e5e85501333
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.
Transparency logRelease files / aiogithubapi-26.0.0-py3-none-any.whl
| Download URL | aiogithubapi-26.0.0-py3-none-any.whl |
|---|---|
| Size | 72.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
156b5f9217d23cb0eb65e233b19c10f499f1ba3bcf1d7d65e3a463c034e3813a
|
|
BLAKE2b-256 checksum How to use checksums |
02a03102dbe2457eceb2e71f295e5d08f0f07c4982f82366cce34b2a332e348e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.
Transparency log