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, **kargs)[source]¶ 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)[source]¶ 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
- tool_shed.webapp.model package
- Subpackages
- tool_shed.webapp.model.migrate package
- Subpackages
- tool_shed.webapp.model.migrate.versions package
- Submodules
- tool_shed.webapp.model.migrate.versions.0001_initial_tables module
- tool_shed.webapp.model.migrate.versions.0002_add_tool_suite_column module
- tool_shed.webapp.model.migrate.versions.0003_review_and_review_association_tables module
- tool_shed.webapp.model.migrate.versions.0004_repository_tables module
- tool_shed.webapp.model.migrate.versions.0005_drop_tool_related_tables module
- tool_shed.webapp.model.migrate.versions.0006_add_email_alerts_column module
- tool_shed.webapp.model.migrate.versions.0007_add_long_description_times_downloaded_columns module
- tool_shed.webapp.model.migrate.versions.0008_add_repository_metadata_table module
- tool_shed.webapp.model.migrate.versions.0009_add_malicious_column module
- tool_shed.webapp.model.migrate.versions.0010_add_new_repo_alert_column module
- tool_shed.webapp.model.migrate.versions.0011_add_tool_versions_column module
- tool_shed.webapp.model.migrate.versions.0012_add_downloadable_column module
- tool_shed.webapp.model.migrate.versions.0013_add_review_tables module
- tool_shed.webapp.model.migrate.versions.0014_add_deprecated_column module
- tool_shed.webapp.model.migrate.versions.0015_add_api_keys_table module
- tool_shed.webapp.model.migrate.versions.0016_add_do_not_test_tools_functionally_correct_errors_columns module
- tool_shed.webapp.model.migrate.versions.0017_add_galaxy_utility_columns_to_repository_metadata_table module
- tool_shed.webapp.model.migrate.versions.0018_add_repository_metadata_flag_columns module
- tool_shed.webapp.model.migrate.versions.0019_add_skip_tool_test_table_and_test_install_error_column module
- tool_shed.webapp.model.migrate.versions.0020_add_repository_type_column module
- tool_shed.webapp.model.migrate.versions.0021_change_repository_type_value module
- tool_shed.webapp.model.migrate.versions.0022_add_repository_admin_roles module
- tool_shed.webapp.model.migrate.versions.0023_add_repository_url_and_hompeage_url module
- tool_shed.webapp.model.migrate.versions.0024_password_reset module
- tool_shed.webapp.model.migrate.versions.0025_session_timeout module
- tool_shed.webapp.model.migrate.versions.0026_add_numeric_revision_column module
- tool_shed.webapp.model.migrate.versions package
- Submodules
- tool_shed.webapp.model.migrate.check module
- Subpackages
- tool_shed.webapp.model.migrate package
- Submodules
- tool_shed.webapp.model.mapping module
- Subpackages
- tool_shed.webapp.search package
- tool_shed.webapp.security package
- tool_shed.webapp.util package
Submodules¶
tool_shed.webapp.app module¶
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]¶
-
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={}, **kwargs)[source]¶ Return a wsgi application serving the root object
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'¶
-
shed_tool_data_path
¶
-
-
tool_shed.webapp.config.
Configuration
¶