balloob / aiogithubapi

Asynchronous Python client for the GitHub API

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 fearure request to have it added or create a PR 🎉. You can also use GitHubAPI.generic while you wait for your request or contribution to be implemented.

For examples on how to use it see the documentation and/or 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 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 the aiogithubapi.helpers.py file
• The GitHubDevice class in aiogithubapi, replaced with GitHubDeviceAPI
• The GitHub class in aiogithubapi, replaced with GitHubAPI

Later this year, warning logs will start to be emitted for deprecated code.

Early next year, the old code will be removed.

Contribute

All contributions are welcome!

1. Fork the repository
2. Clone the repository locally and open the devcontainer or use GitHub codespaces
3. Do your changes
4. Lint the files with make lint
5. Ensure all tests passes with make test
6. Ensure 100% coverage with make coverage
7. Commit your work, and push it to GitHub
8. Create a PR against the main branch