Warning

This document is for an old release 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.webapp.controllers package

Galaxy tool shed controllers.

Submodules

tool_shed.webapp.controllers.admin module

class tool_shed.webapp.controllers.admin.AdminController(app)

Bases: BaseUIController, Admin

user_list_grid: Optional[Grid] = <tool_shed.grids.admin_grids.UserGrid object>

role_list_grid: Optional[Grid] = <tool_shed.grids.admin_grids.RoleGrid object>

group_list_grid: Optional[Grid] = <tool_shed.grids.admin_grids.GroupGrid object>

manage_category_grid = <tool_shed.grids.admin_grids.ManageCategoryGrid object>

repository_grid = <tool_shed.grids.admin_grids.AdminRepositoryGrid object>

repository_metadata_grid = <tool_shed.grids.admin_grids.RepositoryMetadataGrid object>

delete_operation: Optional[GridOperation] = <galaxy.web.legacy_framework.grids.GridOperation object>

undelete_operation: Optional[GridOperation] = <galaxy.web.legacy_framework.grids.GridOperation object>

purge_operation: Optional[GridOperation] = <galaxy.web.legacy_framework.grids.GridOperation object>

browse_repositories(trans, **kwd)

browse_repository_metadata(trans, **kwd)

create_category(trans, **kwd)

delete_repository(trans, **kwd)

delete_repository_metadata(trans, **kwd)

edit_category(trans, **kwd)

Handle requests to edit TS category name or description

manage_categories(trans, **kwd)

regenerate_statistics(trans, **kwd)

manage_role_associations(trans, **kwd)

Manage users, groups and repositories associated with a role.

reset_metadata_on_selected_repositories_in_tool_shed(trans, **kwd)

undelete_repository(trans, **kwd)

mark_category_deleted(trans, **kwd)

purge_category(trans, **kwd)

undelete_category(trans, **kwd)

tool_shed.webapp.controllers.groups module

class tool_shed.webapp.controllers.groups.Group(app)

Bases: BaseUIController

index(trans, **kwd)

tool_shed.webapp.controllers.hg module

class tool_shed.webapp.controllers.hg.PortAsStringMiddleware(application)

Bases: object

__init__(application)

class tool_shed.webapp.controllers.hg.HgController(app)

Bases: BaseUIController

handle_request(trans, **kwd)

tool_shed.webapp.controllers.repository module

tool_shed.webapp.controllers.repository.get_mercurial_default_options_dict(command)

Borrowed from repoman - get default parameters for a mercurial command.

class tool_shed.webapp.controllers.repository.RepositoryController(app)

Bases: BaseUIController, ItemRatings

category_grid = <tool_shed.grids.repository_grids.CategoryGrid object>

datatypes_grid = <tool_shed.grids.repository_grids.DatatypesGrid object>

deprecated_repositories_i_own_grid = <tool_shed.grids.repository_grids.DeprecatedRepositoriesIOwnGrid object>

email_alerts_repository_grid = <tool_shed.grids.repository_grids.EmailAlertsRepositoryGrid object>

docker_image_grid = <tool_shed.grids.repository_grids.DockerImageGrid object>

install_matched_repository_grid = <tool_shed.grids.repository_grids.InstallMatchedRepositoryGrid object>

matched_repository_grid = <tool_shed.grids.repository_grids.MatchedRepositoryGrid object>

my_writable_repositories_grid = <tool_shed.grids.repository_grids.MyWritableRepositoriesGrid object>

my_writable_repositories_missing_tool_test_components_grid = <tool_shed.grids.repository_grids.MyWritableRepositoriesMissingToolTestComponentsGrid object>

my_writable_repositories_with_invalid_tools_grid = <tool_shed.grids.repository_grids.MyWritableRepositoriesWithInvalidToolsGrid object>

repositories_by_user_grid = <tool_shed.grids.repository_grids.RepositoriesByUserGrid object>

repositories_i_own_grid = <tool_shed.grids.repository_grids.RepositoriesIOwnGrid object>

repositories_i_can_administer_grid = <tool_shed.grids.repository_grids.RepositoriesICanAdministerGrid object>

repositories_in_category_grid = <tool_shed.grids.repository_grids.RepositoriesInCategoryGrid object>

repositories_missing_tool_test_components_grid = <tool_shed.grids.repository_grids.RepositoriesMissingToolTestComponentsGrid object>

repositories_with_invalid_tools_grid = <tool_shed.grids.repository_grids.RepositoriesWithInvalidToolsGrid object>

repository_dependencies_grid = <tool_shed.grids.repository_grids.RepositoryDependenciesGrid object>

repository_grid = <tool_shed.grids.repository_grids.RepositoryGrid object>

repository_metadata_grid = <tool_shed.grids.repository_grids.RepositoryMetadataGrid object>

tool_dependencies_grid = <tool_shed.grids.repository_grids.ToolDependenciesGrid object>

tools_grid = <tool_shed.grids.repository_grids.ToolsGrid object>

valid_category_grid = <tool_shed.grids.repository_grids.ValidCategoryGrid object>

valid_repository_grid = <tool_shed.grids.repository_grids.ValidRepositoryGrid object>

browse_categories(trans, **kwd)

browse_datatypes(trans, **kwd)

browse_deprecated_repositories_i_own(trans, **kwd)

browse_my_writable_repositories(trans, **kwd)

browse_my_writable_repositories_missing_tool_test_components(trans, **kwd)

browse_my_writable_repositories_with_invalid_tools(trans, **kwd)

browse_repositories(trans, **kwd)

browse_repositories_by_user(trans, **kwd)

Display the list of repositories owned by a specified user.

browse_repositories_i_can_administer(trans, **kwd)

browse_repositories_i_own(trans, **kwd)

browse_repositories_in_category(trans, **kwd)

browse_repositories_missing_tool_test_components(trans, **kwd)

browse_repositories_with_invalid_tools(trans, **kwd)

browse_repository(trans, id, **kwd)

browse_repository_dependencies(trans, **kwd)

browse_tools(trans, **kwd)

browse_tool_dependencies(trans, **kwd)

browse_valid_categories(trans, **kwd)

Filter repositories per category by those that are valid for installing into Galaxy.

browse_valid_repositories(trans, **kwd)

Filter repositories to those that are installable into Galaxy.

check_for_updates(trans, **kwd)

Handle a request from a local Galaxy instance.

contact_owner(trans, id, **kwd)

create_galaxy_docker_image(trans, **kwd)

create_repository(trans, **kwd)

deprecate(trans, **kwd)

Mark a repository in the tool shed as deprecated or not deprecated.

display_image_in_repository(trans, **kwd)

Open an image file that is contained in repository or that is referenced by a URL for display. The image can be defined in either a README.rst file contained in the repository or the help section of a Galaxy tool config that is contained in the repository. The following image definitions are all supported. The former $PATH_TO_IMAGES is no longer required, and is now ignored. .. image:: https://raw.github.com/galaxy/some_image.png .. image:: $PATH_TO_IMAGES/some_image.png .. image:: /static/images/some_image.gif .. image:: some_image.jpg .. image:: /deep/some_image.png

display_tool(trans, repository_id, tool_config, changeset_revision, **kwd)

download(trans, repository_id, changeset_revision, file_type, **kwd)

Download an archive of the repository files compressed as zip, gz or bz2.

export_via_api(trans, **kwd)

Return an exported gzip compressed repository archive file opened for reading.

find_tools(trans, **kwd)

get_changeset_revision_and_ctx_rev(trans, **kwd)

Handle a request from a local Galaxy instance to retrieve the changeset revision hash to which an installed repository can be updated.

get_ctx_rev(trans, **kwd)

Given a repository and changeset_revision, return the correct ctx.rev() value.

get_file_contents(trans, file_path, repository_id)

get_latest_downloadable_changeset_revision(trans, **kwd)

Return the latest installable changeset revision for the repository associated with the received name and owner. This method is called from Galaxy when attempting to install the latest revision of an installed repository.

get_readme_files(trans, **kwd)

This method is called when installing or re-installing a single repository into a Galaxy instance. If the received changeset_revision includes one or more readme files, return them in a dictionary.

get_repository_dependencies(trans, **kwd)

Return an encoded dictionary of all repositories upon which the contents of the received repository depends.

get_repository_id(trans, **kwd)

Given a repository name and owner, return the encoded repository id.

get_repository_information(trans, repository_ids, changeset_revisions, **kwd)

Generate a list of dictionaries, each of which contains the information about a repository that will be necessary for installing it into a local Galaxy instance.

get_repository_type(trans, **kwd)

Given a repository name and owner, return the type.

get_required_repo_info_dict(trans, encoded_str=None)

Retrieve and return a dictionary that includes a list of dictionaries that each contain all of the information needed to install the list of repositories defined by the received encoded_str.

get_tool_dependencies(trans, **kwd)

Handle a request from a Galaxy instance to get the tool_dependencies entry from the metadata for a specified changeset revision.

get_tool_dependencies_config_contents(trans, **kwd)

Handle a request from a Galaxy instance to get the tool_dependencies.xml file contents for a specified changeset revision.

get_tool_dependency_definition_metadata(trans, **kwd)

Given a repository name and ownerof a repository whose type is tool_dependency_definition, return the current metadata.

get_tool_versions(trans, **kwd)

For each valid /downloadable change set (up to the received changeset_revision) in the repository’s change log, append the changeset tool_versions dictionary to the list that will be returned.

get_updated_repository_information(trans, name, owner, changeset_revision, **kwd)

Generate a dictionary that contains the information about a repository that is necessary for installing it into a local Galaxy instance.

help(trans, **kwd)

index(trans, **kwd)

install_repositories_by_revision(trans, **kwd)

Send the list of repository_ids and changeset_revisions to Galaxy so it can begin the installation process. If the value of repository_ids is not received, then the name and owner of a single repository must be received to install a single repository.

load_invalid_tool(trans, repository_id, tool_config, changeset_revision, **kwd)

manage_email_alerts(trans, **kwd)

manage_repository(trans, id, **kwd)

manage_repository_admins(trans, id, **kwd)

manage_repository_reviews_of_revision(trans, **kwd)

multi_select_email_alerts(trans, **kwd)

next_installable_changeset_revision(trans, **kwd)

Handle a request from a Galaxy instance where the changeset_revision defined for a repository in a dependency definition file is older than the changeset_revision associated with the installed repository.

open_folder(trans, folder_path, repository_id)

preview_tools_in_changeset(trans, repository_id, **kwd)

previous_changeset_revisions(trans, from_tip=False, **kwd)

Handle a request from a local Galaxy instance. This method will handle two scenarios: (1) the repository was previously installed using an older changeset_revsion, but later the repository was updated in the tool shed and the Galaxy admin is trying to install the latest changeset revision of the same repository instead of updating the one that was previously installed. (2) the admin is attempting to get updates for an installed repository that has a repository dependency and both the repository and its dependency have available updates. In this case, the from_tip parameter will be True because the repository dependency definition may define a changeset hash for the dependency that is newer than the installed changeset revision of the dependency (this is due to the behavior of “Tool dependency definition” repositories, whose metadata is always the tip), so the complete list of changset hashes in the changelog must be returned.

rate_repository(trans, **kwd)

Rate a repository and return updated rating data.

reset_all_metadata(trans, id, **kwd)

Reset all metadata on the complete changelog for a single repository in the tool shed.

reset_metadata_on_my_writable_repositories_in_tool_shed(trans, **kwd)

select_files_to_delete(trans, id, **kwd)

send_to_owner(trans, id, message='')

set_email_alerts(trans, **kwd)

Set email alerts for selected repositories.

set_malicious(trans, id, ctx_str, **kwd)

sharable_owner(trans, owner)

Support for sharable URL for each repository owner’s tools, e.g. http://example.org/view/owner.

sharable_repository(trans, owner, name)

Support for sharable URL for a specified repository, e.g. http://example.org/view/owner/name.

sharable_repository_revision(trans, owner, name, changeset_revision)

Support for sharable URL for a specified repository revision, e.g. http://example.org/view/owner/name/changeset_revision.

updated_changeset_revisions(trans, **kwd)

Handle a request from a local Galaxy instance to retrieve the list of changeset revisions to which an installed repository can be updated. This method will return a string of comma-separated changeset revision hashes for all available updates to the received changeset revision. Among other things , this method handles the scenario where an installed tool shed repository’s tool_dependency definition file defines a changeset revision for a complex repository dependency that is outdated. In other words, a defined changeset revision is older than the current changeset revision for the required repository, making it impossible to discover the repository without knowledge of revisions to which it could have been updated.

view_changelog(trans, id, **kwd)

view_changeset(trans, id, ctx_str, **kwd)

view_or_manage_repository(trans, **kwd)

view_repository(trans, id, **kwd)

view_tool_metadata(trans, repository_id, changeset_revision, tool_id, **kwd)

validate_changeset_revision(trans, changeset_revision, repository_id)

In case changeset revision is invalid send them to the repository page

tool_shed.webapp.controllers.repository_review module

class tool_shed.webapp.controllers.repository_review.RepositoryReviewController(app)

Bases: BaseUIController, ItemRatings

component_grid = <tool_shed.grids.repository_review_grids.ComponentGrid object>

repositories_ready_for_review_grid = <tool_shed.grids.repository_review_grids.RepositoriesReadyForReviewGrid object>

repositories_reviewed_by_me_grid = <tool_shed.grids.repository_review_grids.RepositoriesReviewedByMeGrid object>

repositories_with_reviews_grid = <tool_shed.grids.repository_review_grids.RepositoriesWithReviewsGrid object>

repositories_without_reviews_grid = <tool_shed.grids.repository_review_grids.RepositoriesWithoutReviewsGrid object>

repository_reviews_by_user_grid = <tool_shed.grids.repository_review_grids.RepositoryReviewsByUserGrid object>

reviewed_repositories_i_own_grid = <tool_shed.grids.repository_review_grids.ReviewedRepositoriesIOwnGrid object>

repositories_with_no_tool_tests_grid = <tool_shed.grids.repository_review_grids.RepositoriesWithNoToolTestsGrid object>

approve_repository_review(trans, **kwd)

browse_components(trans, **kwd)

browse_review(trans, **kwd)

copy_review(trans, review_to_copy, review)

create_component(trans, **kwd)

create_review(trans, **kwd)

edit_component(trans, **kwd)

edit_review(trans, **kwd)

manage_components(trans, **kwd)

manage_repositories_ready_for_review(trans, **kwd)

A repository is ready to be reviewed if one of the following conditions is met:

1. It contains no tools

2. It contains tools the tools_functionally_correct flag is set to True. This implies that the repository metadata revision was installed and tested by the Tool Shed’s install and test framework.

manage_repositories_reviewed_by_me(trans, **kwd)

manage_repositories_with_invalid_tests(trans, **kwd)

Display a list of repositories that contain tools, have not yet been reviewed, and have invalid functional tests. Tests are defined as invalid if they are missing from the tool config or if defined test data is not included in the repository.

manage_repositories_with_reviews(trans, **kwd)

manage_repositories_without_reviews(trans, **kwd)

manage_repository_reviews(trans, mine=False, **kwd)

manage_repository_reviews_of_revision(trans, **kwd)

repository_reviews_by_user(trans, **kwd)

reviewed_repositories_i_own(trans, **kwd)

select_previous_review(trans, **kwd)

view_or_manage_repository(trans, **kwd)

tool_shed.webapp.controllers.upload module

class tool_shed.webapp.controllers.upload.UploadController(app)

Bases: BaseUIController

upload(trans, **kwd)

upload_directory(trans, rdah, tdah, repository, uploaded_directory, upload_point, remove_repo_files_not_in_tar, commit_message, new_repo_alert)

tool_shed.webapp.controllers.user module

class tool_shed.webapp.controllers.user.User(app: StructuredApp)

Bases: User

index(trans, cntrller='user', **kwd)

login(trans, refresh_frames=None, **kwd)

Handle Galaxy Log in

create(trans, cntrller='user', redirect_url='', refresh_frames=None, **kwd)

reset_password(trans, email=None, **kwd)

Reset the user’s password. Send an email with token that allows a password change.

manage_user_info(trans, cntrller, **kwd)

Manage a user’s login, password, public username, type, addresses, etc.

api_keys(trans, cntrller, **kwd)

edit_username(trans, cntrller, **kwd)

edit_info(trans, cntrller, **kwd)

Edit user information = username, email or password.

change_password(trans, token=None, id=None, **kwd)

Provides a form with which one can change their password. If token is provided, don’t require current password.

logout(trans, logout_all=False, **kwd)