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.

galaxy.tools.linters package

This package contains linting functions for Galaxy tools.

Submodules

galaxy.tools.linters.citations module

This module contains a citation lint function.

Citations describe references that should be used when consumers of the tool publish results.

galaxy.tools.linters.citations.lint_citations(tool_xml, lint_ctx)

Ensure tool contains at least one valid citation.

galaxy.tools.linters.command module

This module contains a linting function for a tool’s command description.

A command description describes how to build the command-line to execute from supplied inputs.

galaxy.tools.linters.command.lint_command(tool_xml, lint_ctx)

Ensure tool contains exactly one command and check attributes.

galaxy.tools.linters.command.get_command(tool_xml)

Get command XML element from supplied XML root.

galaxy.tools.linters.general module

This module contains a linting functions for general aspects of the tool.

galaxy.tools.linters.general.lint_general(tool_source, lint_ctx)

Check tool version, name, and id.

galaxy.tools.linters.help module

This module contains a linting function for a tool’s help.

galaxy.tools.linters.help.lint_help(tool_xml, lint_ctx)

Ensure tool contains exactly one valid RST help block.

galaxy.tools.linters.help.rst_invalid(text)

Predicate to determine if text is invalid reStructuredText.

Return False if the supplied text is valid reStructuredText or a string indicating the problem.

galaxy.tools.linters.inputs module

This module contains a linting functions for tool inputs.

galaxy.tools.linters.inputs.lint_inputs(tool_xml, lint_ctx)

Lint parameters in a tool’s inputs block.

galaxy.tools.linters.inputs.lint_repeats(tool_xml, lint_ctx)

Lint repeat blocks in tool inputs.

galaxy.tools.linters.outputs module

This module contains a linting functions for tool outputs.

galaxy.tools.linters.outputs.lint_output(tool_xml, lint_ctx)

Check output elements, ensure there is at least one and check attributes.

galaxy.tools.linters.stdio module

This module contains a linting functions for tool error detection.

galaxy.tools.linters.stdio.lint_stdio(tool_source, lint_ctx)

galaxy.tools.linters.tests module

This module contains a linting functions for tool tests.

galaxy.tools.linters.tests.lint_tsts(tool_xml, lint_ctx)

galaxy.tools.linters.xml_order module

This module contains a linting functions for tool XML block order.

For more information on the IUC standard for XML block order see - https://github.com/galaxy-iuc/standards.

galaxy.tools.linters.xml_order.lint_xml_order(tool_xml, lint_ctx)