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 package

The Galaxy Tool Shed application.

tool_shed.webapp.url_for(*args, **kargs)

Generates a URL

All keys given to url_for are sent to the Routes Mapper instance for generation except for:

anchor          specified the anchor name to be appened to the path
host            overrides the default (current) host if provided
protocol        overrides the default (current) protocol if provided
qualified       creates the URL with the host/port information as
                needed

The URL is generated based on the rest of the keys. When generating a new URL, values will be used from the current request’s parameters (if present). The following rules are used to determine when and how to keep the current requests parameters:

• If the controller is present and begins with ‘/’, no defaults are used

• If the controller is changed, action is set to ‘index’ unless otherwise specified

For example, if the current request yielded a dict of {‘controller’: ‘blog’, ‘action’: ‘view’, ‘id’: 2}, with the standard ‘:controller/:action/:id’ route, you’d get the following results:

url_for(id=4)                    =>  '/blog/view/4',
url_for(controller='/admin')     =>  '/admin',
url_for(controller='admin')      =>  '/admin/view/2'
url_for(action='edit')           =>  '/blog/edit/2',
url_for(action='list', id=None)  =>  '/blog/list'

Static and Named Routes

If there is a string present as the first argument, a lookup is done against the named routes table to see if there’s any matching routes. The keyword defaults used with static routes will be sent in as GET query arg’s if a route matches.

If no route by that name is found, the string is assumed to be a raw URL. Should the raw URL begin with / then appropriate SCRIPT_NAME data will be added if present, otherwise the string will be used as the url with keyword args becoming GET query args.

tool_shed.webapp.expose(func)

Decorator: mark a function as ‘exposed’ and thus web accessible

Subpackages

• tool_shed.webapp.api package
  • Submodules
  • tool_shed.webapp.api.authenticate module
  • tool_shed.webapp.api.categories module
  • tool_shed.webapp.api.configuration module
  • tool_shed.webapp.api.groups module
  • tool_shed.webapp.api.repositories module
  • tool_shed.webapp.api.repository_revisions module
  • tool_shed.webapp.api.tools module
  • tool_shed.webapp.api.users module
• tool_shed.webapp.controllers package
  • Submodules
  • tool_shed.webapp.controllers.admin module
  • tool_shed.webapp.controllers.groups module
  • tool_shed.webapp.controllers.hg module
  • tool_shed.webapp.controllers.repository module
  • tool_shed.webapp.controllers.repository_review module
  • tool_shed.webapp.controllers.upload module
  • tool_shed.webapp.controllers.user module
• tool_shed.webapp.framework package
  • Subpackages
    • tool_shed.webapp.framework.middleware package
      • Submodules
      • tool_shed.webapp.framework.middleware.remoteuser module
• tool_shed.webapp.model package
  • Subpackages
    • tool_shed.webapp.model.migrate package
      • Subpackages
      • Submodules
      • tool_shed.webapp.model.migrate.check module
  • Submodules
  • tool_shed.webapp.model.mapping module
• tool_shed.webapp.search package
  • Submodules
  • tool_shed.webapp.search.repo_search module
  • tool_shed.webapp.search.tool_search module
• tool_shed.webapp.security package
• tool_shed.webapp.util package
  • Submodules
  • tool_shed.webapp.util.ratings_util module
  • tool_shed.webapp.util.shed_statistics module

Submodules

tool_shed.webapp.app module

class tool_shed.webapp.app.UniverseApplication(**kwd)

Bases: galaxy.structured_app.BasicApp

Encapsulates the state of a Universe application

__init__(**kwd) → None

Parameters

container – Optional container if provided the existing definitions will be copied

:param log_undefined_deps indicates if a log message should be emmited when an undefined dep is loaded

name: str

config: Any

application_stack: galaxy.web_stack.ApplicationStack

datatypes_registry: galaxy.datatypes.registry.Registry

model: galaxy.model.base.SharedModelMapping

security: galaxy.security.idencoding.IdEncodingHelper

auth_manager: galaxy.auth.AuthManager

security_agent: Any

quota_agent: galaxy.quota.QuotaAgent

shutdown()

toolbox: Any

tool_shed.webapp.buildapp module

Provides factory methods to assemble the Galaxy web application

class tool_shed.webapp.buildapp.CommunityWebApplication(galaxy_app, session_cookie='galaxysession', name=None)

Bases: galaxy.webapps.base.webapp.WebApplication

tool_shed.webapp.buildapp.add_ui_controllers(webapp, app)

Search for controllers in the ‘galaxy.webapps.controllers’ module and add them to the webapp.

tool_shed.webapp.buildapp.app_factory(global_conf, load_app_kwds=None, **kwargs)

Return a wsgi application serving the root object

tool_shed.webapp.buildapp.wrap_in_middleware(app, global_conf, application_stack, **local_conf)

Based on the configuration wrap app in a set of common and useful middleware.

tool_shed.webapp.buildapp.wrap_in_static(app, global_conf, **local_conf)

tool_shed.webapp.buildapp.uwsgi_app()

tool_shed.webapp.config module

Universe configuration builder.

class tool_shed.webapp.config.ToolShedAppConfiguration(**kwargs)

Bases: galaxy.config.BaseAppConfiguration, galaxy.config.CommonConfigurationMixin

default_config_file_name = 'tool_shed.yml'

add_sample_file_to_defaults: Set[str] = {'datatypes_config_file'}

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

property shed_tool_data_path

check()

tool_shed.webapp.config.Configuration

alias of tool_shed.webapp.config.ToolShedAppConfiguration