cicd.core.provider

• cicd.core.provider.models
  • cicd.core.provider.models.api
    • API
      • API.get_project()
      • API.get_projects()
      • API.model_config
  • cicd.core.provider.models.base
    • ProviderModel
      • ProviderModel.Config
      • ProviderModel.client
      • ProviderModel.model_config
      • ProviderModel.schema
    • model()
  • cicd.core.provider.models.pr
    • PullRequest
      • PullRequest.id
      • PullRequest.model_config
      • PullRequest.title
  • cicd.core.provider.models.project
    • Project
      • Project.description
      • Project.full_name
      • Project.get_pull_request()
      • Project.get_pull_requests()
      • Project.id
      • Project.identifier
      • Project.model_config
      • Project.name
      • Project.url

cicd.core.provider.client

class cicd.core.provider.client.ProviderClient

Bases: Client, ProviderMixin

An abstract client for CI provider APIs.

get_project(identifier: int | str, **kwargs)

Get the details of a project.

Parameters:

identifier – The identifier of the project.

get_projects(**kwargs)

Get the list of (public) projects.

get_pull_request(project_identifier: int | str, identifier: int | str, **kwargs)

Get the details of a pull/merge request.

Parameters:

• project_identifier – The identifier of the project.

• identifier – The identifier of the pull/merge request.

get_pull_requests(project_identifier: int | str, state: str | None = None, **kwargs)

Get the pull/merge requests of the given project.

Parameters:

• project_identifier – The identifier of the project.

• state – The state (ex. open/closed/all) of the pull/merge requests.

cicd.core.provider.info

class cicd.core.provider.info.ProviderInfo(name: str, module: str)

Bases: object

A data class that holds info of the CI provider such as Github Actions, Gitlab, or CircleCI.

T = ~T

static resolve() → ProviderInfo

Resolve the CI provider info.

Classes of the provider must be placed under cicd.providers.<name>. They will be automatically loaded when resolving the provider info.

static resolve_name() → str

Resolve the name of the CI provider.

shared: T | None = None