Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

tool_shed.capsule package

Submodules

tool_shed.capsule.capsule_manager module

class tool_shed.capsule.capsule_manager.ExportedRepositoryRegistry

Bases: object

__init__()

class tool_shed.capsule.capsule_manager.ExportRepositoryManager(app, user, tool_shed_url, repository, changeset_revision, export_repository_dependencies, using_api)

Bases: object

__init__(app, user, tool_shed_url, repository, changeset_revision, export_repository_dependencies, using_api)

export_repository()

generate_export_elem()

generate_repository_archive(repository, changeset_revision, work_dir)

generate_repository_archive_filename(use_tmp_archive_dir=False)

get_components_from_repo_info_dict(repo_info_dict)

Return the repository and the associated latest installable changeset_revision (including # updates) for the repository defined by the received repo_info_dict.

get_repo_info_dict_for_import(encoded_repository_id, encoded_repository_ids, repo_info_dicts)

The received encoded_repository_ids and repo_info_dicts are lists that contain associated elements at each location in the list. This method will return the element from repo_info_dicts associated with the received encoded_repository_id by determining its location in the received encoded_repository_ids list.

get_repo_info_dicts()

Return a list of dictionaries defining repositories that are required by the repository associated with self.repository_id.

get_repository_attributes_and_sub_elements(repository, archive_name)

Get the information about a repository to create and populate an XML tag set. The generated attributes will be contained within the <repository> tag, while the sub_elements will be tag sets contained within the <repository> tag set.

get_repository_ids(repo_info_dicts)

Return a list of repository ids associated with each dictionary in the received repo_info_dicts.

order_components_for_import(repository_ids, repo_info_dicts)

Some repositories may have repository dependencies that must be imported and have metadata set on them before the dependent repository is imported. This method will inspect the list of repositories about to be exported and make sure to order them appropriately for proper import. For each repository about to be exported, if required repositories are not contained in the list of repositories about to be exported, then they are not considered. Repository dependency definitions that contain circular dependencies should not result in an infinite loop, but obviously ordering the list will not be handled for one or more of the repositories that require prior import.

remove_protocol_from_tool_shed_url()

class tool_shed.capsule.capsule_manager.ImportRepositoryManager(app, host, user, user_is_admin)

Bases: object

__init__(app, host, user, user_is_admin)

check_status_and_reset_downloadable(import_results_tups)

Check the status of each imported repository and set downloadable to False if errors.

create_repository_and_import_archive(repository_archive_dict, import_results_tups)

Create a new repository in the tool shed and populate it with the contents of a gzip compressed tar archive that was exported as part or all of the contents of a capsule.

extract_capsule_files(**kwd)

Extract the uploaded capsule archive into a temporary location for inspection, validation and potential import.

get_archives_from_manifest(manifest_file_path)

Return the list of archive names defined in the capsule manifest. This method will validate the manifest by ensuring all <repository> tag sets contain a valid <archive> sub-element.

get_dependent_downloadable_revisions(repository_metadata)

Return all repository_metadata records that are downloadable and that depend upon the received repository_metadata record.

get_export_info_dict(export_info_file_path)

Parse the export_info.xml file contained within the capsule and return a dictionary containing its entries.

get_repository_info_from_manifest(manifest_file_path)

Parse the capsule manifest and return a list of dictionaries containing information about each exported repository archive contained within the capsule.

get_repository_status_from_tool_shed(repository_info_dicts)

For each exported repository archive contained in the capsule, inspect the Tool Shed to see if that repository already exists or if the current user is authorized to create the repository and set a status appropriately. If repository dependencies are included in the capsule, repositories may have various owners. We will keep repositories associated with owners, so we need to restrict created repositories to those the current user can create. If the current user is an admin or a member of the IUC, all repositories will be created no matter the owner. Otherwise only repositories whose associated owner is the current user will be created.

import_repository_archive(repository, repository_archive_dict)

Import a repository archive contained within a repository capsule.

upload_capsule(**kwd)

Upload and prepare an exported repository capsule for validation.

validate_archive_paths(tar_archive)

Inspect the archive contents to ensure that there are no risky symlinks. Returns True if a suspicious path is found.

validate_capsule(**kwd)

Inspect the uploaded capsule’s manifest and its contained files to ensure it is a valid repository capsule.

verify_archives_in_capsule(file_path, archives)

Inspect the files contained within the capsule and make sure each is defined correctly in the capsule manifest.