octomachinery.github.api.raw_client module

A very low-level GitHub API client.

class octomachinery.github.api.raw_client.RawGitHubAPI(token: octomachinery.github.api.tokens.GitHubToken, *, session: Optional[aiohttp.client.ClientSession] = None, user_agent: Optional[str] = None, **kwargs)[source]

Bases: gidgethub.aiohttp.GitHubAPI

A low-level GitHub API client with a pre-populated token.

delete(url: str, url_vars: Dict = {}, *, data: Any = b'', preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → None
getitem(url: str, url_vars: Dict = {}, *, preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → Any

Send a GET request for a single item to the specified endpoint.

getiter(url: str, url_vars: Dict = {}, *, preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → AsyncGenerator[Any, None]

Return an async iterable for all the items at a specified endpoint.

property is_initialized

Return GitHub token presence.

patch(url: str, url_vars: Dict = {}, *, data: Any, preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → Any
post(url: str, url_vars: Dict = {}, *, data: Any, preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → Any
put(url: str, url_vars: Dict = {}, *, data: Any = b'', preview_api_version: Optional[str] = None, accept: str = 'application/vnd.github.v3+json', jwt: Optional[str] = None, oauth_token: Optional[str] = None) → Any