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.webapp package

The Galaxy Tool Shed application.

tool_shed.webapp.url_for(*args, **kwargs)str

Tries to resolve the URL using the routes module.

This only works in a WSGI app so a deprecation message is returned when running an ASGI app.

tool_shed.webapp.expose(func)[source]

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

Submodules

tool_shed.webapp.app module

class tool_shed.webapp.app.UniverseApplication(**kwd)[source]

Bases: galaxy.structured_app.BasicApp

Encapsulates the state of a Universe application

__init__(**kwd)None[source]
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()[source]
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)[source]

Bases: galaxy.webapps.base.webapp.WebApplication

tool_shed.webapp.buildapp.add_ui_controllers(webapp, app)[source]

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)[source]

Return a wsgi application serving the root object

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

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)[source]
tool_shed.webapp.buildapp.uwsgi_app()[source]

tool_shed.webapp.config module

Universe configuration builder.

class tool_shed.webapp.config.ToolShedAppConfiguration(**kwargs)[source]

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)[source]

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

property shed_tool_data_path
check()[source]
tool_shed.webapp.config.Configuration

alias of tool_shed.webapp.config.ToolShedAppConfiguration