octomachinery.github.api.raw_client module¶

A very low-level GitHub API client.

class octomachinery.github.api.raw_client.RawGitHubAPI(token: GitHubToken, *, user_agent: str | None = None, **kwargs: Any)[source]¶

Bases: GitHubAPI

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

delete(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, data: Any = b'', preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None) → None¶
getitem(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None) → Any¶

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

getiter(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None, iterable_key: str | None = 'items') → AsyncGenerator[Any, None]¶

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

property is_initialized: bool¶

Return GitHub token presence.

patch(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, data: Any, preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None) → Any¶
post(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, data: Any, preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None, content_type: str = 'application/json') → Any¶
put(url: str, url_vars: Mapping[str, Sequence[int | float | complex | str | None] | List[int | float | complex | str | None] | Mapping[str, int | float | complex | str | None] | Tuple[str, int | float | complex | str | None] | int | float | complex | str | None] | None = {}, *, data: Any = b'', preview_api_version: str | None = None, accept: str = 'application/vnd.github.v3+json', jwt: str | None = None, oauth_token: str | None = None, extra_headers: dict[str, str] | None = None) → Any¶