cicd.core

• cicd.core.cipher
  • cicd.core.cipher.cipher
    • Cipher
      • Cipher.Action
      • Cipher.perform()
  • cicd.core.cipher.cli
    • perform()
• cicd.core.mixin
  • cicd.core.mixin.core
    • CoreMixin
  • cicd.core.mixin.git
    • GitMixin
      • GitMixin.git
      • GitMixin.repo
  • cicd.core.mixin.logger
    • LoggerMixin
      • LoggerMixin.logger
  • cicd.core.mixin.provider
    • ProviderMixin
      • ProviderMixin.T
      • ProviderMixin.provider
      • ProviderMixin.provider_cls()
      • ProviderMixin.provider_info
      • ProviderMixin.reset_provider()
  • cicd.core.mixin.step
    • StepMixin
      • StepMixin.step()
• cicd.core.provider
  • cicd.core.provider.models
    • cicd.core.provider.models.api
      • API
    • cicd.core.provider.models.base
      • ProviderModel
      • model()
    • cicd.core.provider.models.pr
      • PullRequest
    • cicd.core.provider.models.project
      • Project
  • cicd.core.provider.client
    • ProviderClient
      • ProviderClient.get_project()
      • ProviderClient.get_projects()
      • ProviderClient.get_pull_request()
      • ProviderClient.get_pull_requests()
  • cicd.core.provider.info
    • ProviderInfo
      • ProviderInfo.T
      • ProviderInfo.resolve()
      • ProviderInfo.resolve_name()
      • ProviderInfo.shared
• cicd.core.security
  • cicd.core.security.keychain
    • Keychain
      • Keychain.add_to_user_search_list()
      • Keychain.create()
      • Keychain.delete()
      • Keychain.import_cert()
      • Keychain.prepare()
      • Keychain.unlock()
      • Keychain.user_search_list()
• cicd.core.syntax
  • cicd.core.syntax.data_represented
    • DataRepresentedObject
      • DataRepresentedObject.as_type()
      • DataRepresentedObject.query()
      • DataRepresentedObject.save()
  • cicd.core.syntax.json
    • JSON
      • JSON.from_str()
      • JSON.to_str()
  • cicd.core.syntax.yaml
    • YAML
• cicd.core.utils
  • cicd.core.utils.cli_group
    • cli_group()
  • cicd.core.utils.file
    • FileUtils
      • FileUtils.copy()
      • FileUtils.tempdir()
  • cicd.core.utils.sh
    • Shell
      • Shell.ExecError
      • Shell.exec()
      • Shell.popen()
      • Shell.quote()
  • cicd.core.utils.step
    • step()
  • cicd.core.utils.timeout
    • Timeout
      • Timeout.TimeoutError
    • timeout()

cicd.core.action

class cicd.core.action.Action(**kwargs)

Bases: CoreMixin

run()

cicd.core.cli

cicd.core.client

class cicd.core.client.Client

Bases: object

Base class that provides building blocks for API wrappers.

Clients are per-class singletons.

BASE_URL: str | None = None

config(base_url: str | None = None, token: str | None = None, **kwargs) → T

Config the client.

Parameters:

• base_url – The base url of the APIs.

• token – The API token used in each request.

Returns:

The current client.

make_headers() → Dict[str, Any]

Make up headers for each requests.

Subclasses override this function to append/modify request headers.

make_paging_params(paging: int | Tuple[int, int] | List[int]) → Dict[str, Any]

Make up paging params for request params.

request(endpoint: str, method: str = 'get', as_type: Type[D] | None = None, to_list: bool = False, **kwargs) → D | None

Make an API request.

Parameters:

• endpoint – The API endpoint.

• method – The request method (default as get).

• as_type – The model to which the raw content should be converted.

• to_list – Whether the return value should be a list, used together with as_type.

Returns:

The model/list of models (if as_type is specified), or the json content, or the raw content.

token: str | None = None

cicd.core.env

class cicd.core.env.Env

Bases: ProviderMixin

ci: bool = False

cicd.core.logger

cicd.core.logger.default_formatter(fmt=None)

cicd.core.logger.setup_logger(name, fmt=None) → Logger

cicd.core.typing

cicd.core.version

class cicd.core.version.Version(version: str)

Bases: Version

next(component: str = 'micro') → Version