params is a dictionary with following mandatory params:

Parameters:

• url (str) –

  Artifactory host url

• username (str) –

  User used in auth request

• password (str) –

  Token used in auth request

get_artifact_properties(path_to_artifact: str)

get_folder_files_list(path_to_folder: str)

get_artifact_content_by_url(path_to_file: str)

Allows searching for specific descriptor artifacts in different repositories without knowing full coordinates (e.g. knowing only artifact_id and version, but not its group_id)

Supports different repository providers: Artifactory, Nexus, AWS, GCP, Azure

Provides different auth methods for Cloud Providers, implementing CloudCredentialsProvider interface

Start by initializing this client with one of implementations: finder = ArtifactFinder(artifact_provider=ArtifactoryProvider(registry_url="https://our_url", username="user", password="password"))

Then find your artifacts using resource_urls = finder.find_artifact_urls(artifact_id='art_id', version='1.0.0', extension='json')

Additionally, perform filtering of returned results (if you expect to find more than one artifact), and then download necessary artifacts with finder.download_artifact(one_of_the_returned_resource_urls, './my_artifact.json')

For more complex providers (e.g. AWS Code Artifact), you need to use specific Credential Providers As an example:

aws_creds = AwsCredentialsProvider().with_assume_role(...all the required params...).get_credentials()
aws_code_artifact_provider = AwsCodeArtifactProvider(creds=creds, domain='our_domain', project='our_project')
finder = ArtifactFinder(artifact_provider=aws_code_artifact_provider)

Parameters:

• host (str) –

  Git instance URL

• username (str) –

  User used in auth request

• password (str) –

  Token used in auth request

• email (str, default: None ) –

  Email used when committing changes using client

clone(repo_path: str, branch: str, temp_path: str, **kwargs)

clone_repo_from_commit_hash(repo_path: str, commit_hash: str, temp_path: str)

commit_and_push(commit_message: str)

commit(commit_message: str)

push()

pull(**kwargs)

get_file_content_utf8(relative_path: str)

set_file_content_utf8(relative_path: str, content: str)

delete_by_path(relative_path: str)

Bases: GithubClient

This class is deprecated and will be removed in v3.0.0. Use class from v2 module instead. Arguments: token (str): Token used in auth request api_url (str): Optional Github Enterprise API URL, leave empty if using github.com **kwargs (Any): will be passed into Github API constructor

trigger_workflow(owner: str, repo_name: str, workflow_file_name: str, branch: str, pipeline_params: dict, timeout_seconds: float = 30.0, wait_seconds: float = 3.0, find_via_uuid: bool = False, uuid_param_name: str = DEFAULT_UUID_PARAM_NAME, uuid_artifact_name: str = DEFAULT_UUID_ARTIFACT_NAME, uuid_file_name: str = DEFAULT_UUID_FILE_NAME)

get_workflow_run_status(execution: ExecutionInfo)

wait_workflow_run_execution(execution: ExecutionInfo, timeout_seconds: float = 60.0, break_status_list: list = None, wait_seconds: float = 10.0)

cancel_workflow_run_execution(execution: ExecutionInfo, timeout: float = 1.0)

download_workflow_run_artifacts(execution: ExecutionInfo, local_dir: str)

get_workflow_run_input_params(execution: ExecutionInfo, artifact_name: str = DEFAULT_UUID_ARTIFACT_NAME, file_name: str = DEFAULT_UUID_FILE_NAME)

Bases: GitlabClient

This class is deprecated and will be removed in v3.0.0. Use class from v2 module instead. Arguments: host (str): Gitlab instance URL username (str): User used in auth request, might be empty string if no auth is required password (str): Token used in auth request email (str): Email used when committing changes using API **kwargs (Any): will be passed into Gitlab API constructor

trigger_pipeline(project_id: str, ref: str, trigger_token: str = None, variables: dict = None, use_ci_job_token: bool = False)

create_pipeline(project_id: str, ref: str, variables: dict)

get_file_content(project_id: str, ref: str, file_path: str)

create_file(project_id: str, file_path: str, content: str, ref: str, commit_message: str)

update_file(project_id: str, file_path: str, content: str, ref: str, commit_message: str, create_if_not_exists: bool = False)

delete_file(project_id: str, file_path: str, ref: str, commit_message: str)

get_latest_commit_id(project_id: str, ref: str)

get_file_commit_info(project_id: str, ref: str, file_path: str)

cancel_pipeline_execution(execution: ExecutionInfo, timeout: float = 1.0)

get_pipeline_status(execution: ExecutionInfo)

wait_pipeline_execution(execution: ExecutionInfo, timeout_seconds: float = 180.0, break_status_list: list = None, wait_seconds: float = 1.0)

get_repo_branch_path(url: str, branch: str = 'main')

is_gitlab_project_exist(gitlab_url, gitlab_project, gitlab_token)

search_group_id(gitlab_url, gitlab_project, gitlab_token)

create_internal_gitlab_project(gitlab_url, gitlab_token, group_id, repo_name, repo_branch, visibility='internal')

make_first_commit_to_gitlab_project(gitlab_url, gitlab_token, project_id, repo_branch)

Bases: JenkinsClient

This class is deprecated and will be removed in v3.0.0. Use class from v2 module instead. Arguments: host (str): Jenkins host URL user (str): User used in auth request password (str): Token used in auth request

run_pipeline(job_name: str, job_params: dict, timeout_seconds: float = 180.0, wait_seconds: float = 1.0)

get_pipeline_execution_status(execution: ExecutionInfo, timeout_seconds: float = 30.0, wait_seconds: float = 1.0)

wait_pipeline_execution(execution: ExecutionInfo, timeout_seconds: float = 180.0, wait_seconds: float = 1.0)

cancel_pipeline_execution(execution: ExecutionInfo, timeout_seconds: float = 30.0, wait_seconds: float = 1.0)

get_pipeline_execution_artifacts(execution: ExecutionInfo, timeout_seconds: float = 30.0, wait_seconds: float = 1.0)

save_pipeline_execution_artifact_to_file(execution: ExecutionInfo, artifact_path: str, file_path: str)

Needs either of endpoint and token or kubeconfig_path

Parameters:

• endpoint (str, default: None ) –

  Kubernetes API server URL

• token (str, default: None ) –

  Token used for cluster access

• kubeconfig_path (str, default: None ) –

  Path to local .kubeconfig file

list_namespaces()

namespace_exists(namespace: str)

deployments_exist(namespace: str)

is_namespace_scaled_to_zero(namespace: str)

list_not_ready_resources(namespace)

create_namespace(namespace: str)

delete_namespaces(namespaces: list[str], ignore_not_found: bool = False)

list_config_map_names(namespace: str)

read_config_map(namespace: str, config_map_name: str)

create_config_map(namespace: str, config_map_name: str, config_map_data: dict)

patch_config_map(namespace: str, config_map_name: str, config_map_data: dict)

replace_config_map(namespace: str, config_map_name: str, config_map_data: dict)

create_or_replace_config_map(namespace: str, config_map_name: str, config_map_data: dict)

delete_config_map(namespace: str, config_map_name: str)

scale_namespace(namespace: str, scale_mode: ScaleMode, use_config_map: bool = True, replicas: int = 0)

scale_namespace_down(namespace: str)

scale_namespace_up(namespace: str, use_config_map: bool, replicas: int = 0)

Parameters:

• endpoint (str) –

  MiniO host URL

• access_key (str) –

  Access key used in auth request

• secret_key (str) –

  Secret key used in auth request

• secure (bool, default: True ) –

  Which protocol to use (in case it's not present in endpoint)

• cert_check (bool, default: True ) –

  Whether to verify certificate

list_objects(bucket_name: str, path: str = None)

get_folder_names(bucket_name: str, path: str = None)

get_file_names(bucket_name: str, path: str = None)

get_last_modified_file(bucket_name: str, path: str = None)

get_last_modified_text_file_content(bucket_name: str, path: str = None)

get_file(bucket_name: str, file_path: str, local_path: str)

put_file(bucket_name: str, path: str, local_path: str)

get_text_file_content(bucket_name: str, file_path: str)

proxies dict for different protocols is passed to requests session. e.g. proxies = { 'https' : 'https://user:password@ip:port' }

Parameters:

• bot_token (str) –

  bot's auth token

• proxies (dict, default: None ) –

  dict with proxy connections for different protocols

send_message(room_id: str, msg: str = None, attachment_path: str = None, parent_id: str = None, to_person_id: str = None, to_person_email: str = None, markdown: str = None, **request_parameters)