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.
python3 -m pip install aiogithubapi
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 is now considered deprecated. Which includes:
- The
aiogithubapi.common
module - The
aiogithubapi.legacy
module - The
aiogithubapi.objects
module - All classes starting with
AIOGitHub
- The
async_call_api
function in theaiogithubapi.helpers.py
file - The
GitHubDevice
class inaiogithubapi
, replaced withGitHubDeviceAPI
- The
GitHub
class inaiogithubapi
, replaced withGitHubAPI
Later this year (2022), warning logs will start to be emitted for deprecated code.
Early next year (2023), the old code will be removed.
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
make lint
- Ensure all tests passes with
make test
- Ensure 100% coverage with
make coverage
- Commit your work, and push it to GitHub
- Create a PR against the
main
branch