octomachinery.github.models.checks_api_requests module#

Models representing objects in GitHub Checks API.

class octomachinery.github.models.checks_api_requests.NewCheckRequest(head_branch, head_sha, name, details_url: Optional[str] = None, external_id: Optional[str] = None, status: Optional[str] = 'queued', started_at: Optional[str] = None, conclusion: Optional[str] = None, completed_at: Optional[str] = None, output=None, actions=[])[source]#

Bases: NewCheckRequestMixin, BaseCheckRequestMixin

Checks API new check request.

head_branch: str#

head_sha: str#

class octomachinery.github.models.checks_api_requests.UpdateCheckRequest(name, details_url: Optional[str] = None, external_id: Optional[str] = None, status: Optional[str] = 'queued', started_at: Optional[str] = None, conclusion: Optional[str] = None, completed_at: Optional[str] = None, output=None, actions=[])[source]#

Bases: BaseCheckRequestMixin

Checks API update check request.

actions: List[CheckActions]#

completed_at: Optional[str]#

conclusion: Optional[str]#

details_url: Optional[str]#

external_id: Optional[str]#

name: str#

output: Optional[CheckOutput]#

started_at: Optional[str]#

status: Optional[str]#

octomachinery.github.models.checks_api_requests.to_gh_query(req)[source]#: Convert Checks API request object into a dict.