aiogithubapi 21.2.0

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.

For examples on how to use it see the documentation and/or the tests dir.

Install

python3 -m pip install aiogithubapi

Add Data Objects

Currently this will only work properly on single GET responses, if the sample response is a list, just use the first dict in the list

1. Find the response you want from https://docs.github.com/en/rest/reference
2. Find the URL directly to the correct section (like https://docs.github.com/en/rest/reference/issues#get-a-label)
3. Expand the "Default response" section, and copy the contents to generate/input.json
4. Run python generate/genreate.py && black .
   1. You will be asked for the URL, laste the link you found in step 2.
   2. You will be asked for the main class name, use something that make sense.

Examples:

• issues#get-a-label Would be IssuesLabel
• projects#get-a-project-card Would be ProjectCard
• pulls#get-a-pull-request Would be PullRequest
• repos#get-a-branch Would be ReposBranch

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 black
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