aiogithubapi 1.1.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.

Install

python3 -m pip install -U aiogithubapi

Example

"""Example usage of AIOGitHubAPI"""
import asyncio
from aiogithubapi import GitHub


async def example():
    """Example usage of AIOGitHubAPI."""
    async with GitHub() as github:
        repository = await github.get_repo("ludeeus/aiogithubapi")
        print("Repository description:", repository.full_name)
        print("Repository description:", repository.description)


asyncio.get_event_loop().run_until_complete(example())

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