repositorytools.lib package

Submodules

repositorytools.lib.artifact module

exception repositorytools.lib.artifact.NameVerDetectionError

Bases: repositorytools.lib.artifact.ArtifactError

class repositorytools.lib.artifact.Artifact(group, artifact='', version='', classifier='', extension='')

Bases: object

Generic class describing an artifact

get_coordinates_string()

class repositorytools.lib.artifact.LocalArtifact(group, local_path, artifact='', version='', classifier='', extension='')

Bases: repositorytools.lib.artifact.Artifact

Artifact for upload to repository

detect_name_ver_ext()

class repositorytools.lib.artifact.LocalRpmArtifact(local_path, group=None)

Bases: repositorytools.lib.artifact.LocalArtifact

Special case of local artifact, which can detect it’s coordinates from RPM metadata

static get_artifact_group(url)

class repositorytools.lib.artifact.RemoteArtifact(group=None, artifact='', version='', classifier='', extension='', url=None, repo_id=None)

Bases: repositorytools.lib.artifact.Artifact

Artifact in repository

classmethod from_repo_id_and_coordinates(repo_id, coordinates)

Parameters:

• repo_id –
• coordinates – e.g. ‘com.fooware:foo:1.0.0’

Returns:

repositorytools.lib.repository module

Contains classes for manipulating with a repository server

exception repositorytools.lib.repository.RepositoryClientError

Bases: exceptions.Exception

Base exception raised when working with NexusRepositoryClient and its descendants

exception repositorytools.lib.repository.WrongDataTypeError

Bases: repositorytools.lib.repository.RepositoryClientError

exception repositorytools.lib.repository.ArtifactNotFoundError

Bases: repositorytools.lib.repository.RepositoryClientError

class repositorytools.lib.repository.NexusRepositoryClient(repository_url=None, user=None, password=None, verify_ssl=True)

Bases: object

Class for working with Sonatype Nexus OSS

DEFAULT_REPOSITORY_URL = 'https://repository'

delete_artifact(url)

Deletes an artifact from repository.

Parameters:url – string Returns:

resolve_artifact(remote_artifact)

upload_artifacts(local_artifacts, repo_id, print_created_artifacts=True, _hostname_for_download=None, _path_prefix='content/repositories', use_direct_put=False)

Uploads artifacts to repository.

Parameters:

• local_artifacts – list[LocalArtifact]
• repo_id – id of target repository
• print_created_artifacts – if True prints to stdout what was uploaded and where

Returns:

list[RemoteArtifact]

class repositorytools.lib.repository.NexusProRepositoryClient(repository_url=None, user=None, password=None, verify_ssl=True, staging_repository_url=None)

Bases: repositorytools.lib.repository.NexusRepositoryClient

Class for working with Sonatype Nexus Professional

close_staging_repo(repo_id, description='')

Closes a staging repository. After close, no files can be added.

Parameters:

• repo_id – id of staging repository
• description – if specified, updates description of staged repository

Returns:

close_staging_repos(repo_ids, description='')

Closes multiple staging repositories.

Parameters:

• repo_ids – list of repo IDs (strings) For description of other params see close_staging_repo.
• description – Description message.

Returns:

create_staging_repo(profile_name, description)

Creates a staging repository :param profile_name: name of staging profile :param description: description of created staging repository :return: id of newly created staging repository

drop_staging_repo(repo_id, description='No description')

Deletes a staging repository and all artifacts inside.

Parameters:repo_id – id of staging repository Returns:

drop_staging_repos(repo_ids, description='No description')

Deletes multiple staging repositories.

Parameters:repo_ids – list of repo IDs (strings) Returns:

get_artifact_metadata(remote_artifact)

Gets artifact’s maven metadata.

Metadata capability needs to be enabled to use this. Also indexing has to be enabled for that repo to make it work.

Parameters:remote_artifact – Returns:

list_staging_repos(filter_dict=None)

Parameters:filter_dict – dictionary with filters, for example {‘description’:’foo’} Returns:list of dictionaries, each dict describes one staging repo

release_staging_repo(repo_id, description='No description', auto_drop_after_release=True, keep_metadata=False)

Releases all contents of a staging repository to a release repository which this staging repository targets.

Parameters:

• repo_id – id of staging repository
• description –
• auto_drop_after_release – set this to True if you want to delete the staging repository after releasing
• keep_metadata – Keeps custom maven metadata of artifacts after release. Works only there is list of artifacts created by upload_artifacts_to_new_staging with upload_filelist=False. It is because current Nexus 2.x can’t do keep the metadata after release, so we manually read the metadata, release and then set them again.

Returns:

set_artifact_metadata(remote_artifact, metadata)

Sets artifact metadata.

The same requirements as for get_artifact_metadata have to be met.

Parameters:

• remote_artifact –
• metadata – dict of keys and values you want to save there

Returns:

upload_artifacts_to_new_staging(local_artifacts, repo_id, print_created_artifacts=True, description='No description', upload_filelist=False)

Creates a staging repository in staging profile with name repo_id and uploads local_artifacts there.

Parameters:

• local_artifacts – list[LocalArtifact]
• repo_id – name of target repository
• print_created_artifacts – if True prints to stdout what was uploaded and where
• description – description of staging repo
• upload_filelist – see upload_artifacts_to_staging

Returns:

list[RemoteArtifact]

upload_artifacts_to_staging(local_artifacts, repo_id, print_created_artifacts=True, upload_filelist=False)

Parameters:

• local_artifacts – list[LocalArtifact]
• repo_id – name of staging repository
• print_created_artifacts – if True prints to stdout what was uploaded and where
• staging – bool
• upload_filelist – if True, creates and uploads a list of uploaded files

Returns:

list[RemoteArtifact]

repositorytools.lib.repository.repository_client_factory(*args, **kwargs)

Detects which kind of repository user wants to use and returns appropriate instance of it.

Parameters:

• args –
• kwargs –

Returns: