Command-line utilities to assist in building tools for the Galaxy project (http://galaxyproject.org/).

Navigation

Project links

Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Academic Free License (AFL) (AFL)

Author: Galaxy Project and Community

Tags planemo

Maintainers

Avatar for bgruening from gravatar.com bgruening Avatar for jmchilton from gravatar.com jmchilton Avatar for mvdbeek from gravatar.com mvdbeek Avatar for natefoo from gravatar.com natefoo Avatar for nsoranzo from gravatar.com nsoranzo

Classifiers

Project description

Planemo Logo

Command-line utilities to assist in developing Galaxy and Common Workflow Language tools.

Documentation Status Planemo on the Python Package Index (PyPI) Build Status Build Status of Extended Tests Coverage Status

Quick Start

Obtaining

For a traditional Python installation of Planemo, first set up a virtualenv for planemo (this example creates a new one in .venv) and then install with pip. Planemo requires pip 7.0 or newer.

$ virtualenv .venv; . .venv/bin/activate
$ pip install "pip>=7" # Upgrade pip if needed.
$ pip install planemo

For information on updating Planemo, installing the latest development release, or installing Planemo via Bioconda - checkout the installation documentation.

Planemo is also available as a virtual appliance bundled with a preconfigured Galaxy server and set up for Galaxy and Common Workflow Language tool development. You can choose from open virtualization format (OVA, .ova) or Docker appliances.

Basics - Galaxy

This quick start will assume you have a directory with one or more Galaxy tool XML files. If no such directory is available, one can be quickly created for demonstrating planemo as follows project_init --template=demo mytools; cd mytools.

Planemo can check tool XML files for common problems and best practices using the lint command (also aliased as l).

$ planemo lint

Like many planemo commands - by default this will search the current directory and use all tool files it finds. It can be explicitly passed a path to tool files or a directory of tool files.

$ planemo l randomlines.xml

The lint command takes in additional options related to reporting levels, exit code, etc. These options are described in the docs or (like with all commands) can be accessed by passing --help to it.

$ planemo l --help
Usage: planemo lint [OPTIONS] TOOL_PATH

Once tools are syntactically correct - it is time to test. The test command can be used to test a tool or a directory of tools.

$ planemo test --galaxy_root=../galaxy randomlines.xml

If no --galaxy_root is defined, Planemo will download and configure a disposable Galaxy instance for testing.

Planemo will create a HTML output report in the current directory named tool_test_output.html (override with --test_output). See an example of such a report for Tophat.

Once tools have been linted and tested - the tools can be viewed in a Galaxy interface using the serve (s) command.

$ planemo serve

Like test, serve requires a Galaxy root and one can be explicitly specified with --galaxy_root or installed dynamically with --install_galaxy.

For more information on building Galaxy tools in general please check out Building Galaxy Tools Using Planemo.

Basics - Common Workflow Language

This quick start will assume you have a directory with one or more Common Workflow Language YAML files. If no such directory is available, one can be quickly created for demonstrating planemo as follows planemo project_init --template=seqtk_complete_cwl mytools; cd mytools.

Planemo can check tools YAML files for common problems and best practices using the lint command (also aliased as l).

$ planemo lint

Like many planemo commands - by default this will search the current directory and use all tool files it finds. It can be explicitly passed a path to tool files or a directory of tool files.

$ planemo l seqtk_seq.cwl

The lint command takes in additional options related to reporting levels, exit code, etc. These options are described in the docs or (like with all commands) can be accessed by passing --help to it.

$ planemo l --help
Usage: planemo lint [OPTIONS] TOOL_PATH

Once tools are syntactically correct - it is time to test. The test command can be used to test a CWL tool, workflow, or a directories thereof.

$ planemo test --engine cwltool seqtk_seq.cwl

Planemo will create a HTML output report in the current directory named tool_test_output.html. Check out the file seqtk_seq_tests.yml for an example of Planemo test for a CWL tool. A test consists of any number of jobs (with input descriptions) and corresponding output assertions.

Checkout the Commmon Workflow User Guide for more information on developing CWL tools in general and Building Common Workflow Language Tools for more information on using Planemo to develop CWL tools.

Tool Shed

Planemo can help you publish tools to the Galaxy Tool Shed. Check out Publishing to the Tool Shed for more information.

Conda

Planemo can help develop tools and Conda packages in unison. Check out the Galaxy or CWL version of the “Dependencies and Conda” tutorial for more information.

Docker and Containers

Planemo can help develop tools that run in “Best Practice” containers for scientific workflows. Check out the Galaxy or CWL version of the “Dependencies and Containers” tutorial for more information.

History

0.70.0 (2020-01-29)

0.62.1 (2019-10-14)

  • Init & update submodules when installing and creating packages. Stop distributing eggs (thanks to @nsoranzo). 1ab8530

0.62.0 (2019-10-11)

0.61.0 (2019-07-08)

0.60.0 (2019-05-31)

0.59.0 (2019-05-09)

0.58.2 (2019-03-01)

0.58.1 (2019-01-03)

0.58.0 (2019-01-01)

0.57.1 (2018-11-23)

0.57.0 (2018-11-19)

0.56.0 (2018-10-30)

0.55.0 (2018-09-12)

0.54.0 (2018-06-06)

0.53.0 (2018-05-22)

  • Make Planemo testing easier for CWL tools and workflows in various ways and update tutorials to reflect these simplifications. Pull Request 837
  • Test and fix running workflow tests against externally managed Galaxy servers. Pull Request 833, Pull Request 836
  • Allow using URIs for inputs of workflow test. Pull Request 840
  • Slide Galaxy testing window to include 18.05 and drop 17.09. Pull Request 838

0.52.0 (2018-05-20)

0.51.0 (2018-05-19)

  • Fix essentially all Conda and BioContainers related functionality to allow parity between CWL and existing Galaxy functionality - fixes and enhances many commands including lint, conda_install, conda_env, test, run, and mull. Pull Request 828
  • Add two new tutorials for Conda and Container development with CWL tools that mirrors the existing tutorials for Galaxy tools - including new CWL exercises, answers, and example project templates. 347c622
  • Improve the CWL generated by the tool_init command to properly deal with SoftwareRequirement s and generate more idiomatic CWL. Pull Request 820, a5c72e3
  • Add new engine type (--engine toil) for testing and running CWL tools (requires manually installing Toil with pip install toil in Planemo’s environment). Pull Request 831
  • Add documentation for the Galaxy Workflow and CWL test format files (includes information on configuring various test engines). Pull Request 832
  • Better default logging config for CWL development. Pull Request 830
  • Various fixes for the conda_search command. Pull Request 826
  • Fix test coverage configuration. Pull Request 822
  • Reorganize .travis.yml for clarity. Pull Request 829
  • More isolated, robust unit tests that use git. Pull Request 827, Pull Request 818
  • Fix default list of best-practice Conda channels. Pull Request 825
  • Refactor tests to speed up quick tests - fewer buggy URLs fetched in “quick” mode. Pull Request 823
  • Fix upload configuration of workflow testing to default (overrideable) external Galaxies to not use path pasting. Pull Request 816
  • Fix test number parsing for workflow tests. Pull Request 817

0.50.1 (2018-05-11)

  • Fix the process of waiting on Galaxy to boot up for the Docker Galaxy container --engine.

0.50.0 (2018-05-10)

  • Fixes and small CLI tweaks to get the Docker Galaxy container working as an --engine for the run, serve, and test commands.

0.49.2 (2018-05-09)

  • Various small fixes for new external Galaxy engine type.

0.49.1 (2018-05-06)

  • Fix PyPI README rendering for 0.49.0 release changes.

0.49.0 (2018-05-06)

0.48.0 (2018-02-28)

0.47.0 (2017-11-18)

0.46.1 (2017-09-26)

0.46.0 (2017-09-15)

0.45.0 (2017-09-06)

0.44.0 (2017-06-22)

0.43.0 (2017-06-22)

  • Remove stdio from generated tools - just use exit_code for everything. 91b6fa0
  • Implement some ad-hoc documentation tests. Pull Request 699
  • A large number of small enhancements and fixes for the documentation and example projects.

0.42.1 (2017-06-16)

  • Fix Readme typos (thanks to @manabuishii) 904d77a
  • Fix container_register to create pull requests against the newly finalized home of the multi-package-containers registry repository. 9636682
  • Fix use_global_config and use_env_var for options with unspecified defaults. 475104c

0.42.0 (2017-06-15)

0.41.0 (2017-06-05)

0.40.1 (2017-05-03)

0.40.0 (2017-03-16)

  • Implement instructions and project template for GA4GH Tool Execution Challenge Phase 1. 84c4a73
  • Eliminate Conda hack forcing /tmp as temp directory. b4ae44d
  • Run dependency script tests in isolated directories. 32f41c9
  • Fix OS X bug in planemo run by reworking it to wait using urllib instead of sockets. 3129216

0.39.0 (2017-03-15)

  • Implement documentation and examples for Conda-based dependency development (under “Advanced” topics). Pull Request 642, Pull Request 643
  • Implement documentation and examples for container-based dependency development (under “Advanced” topics). 0a1abfe
  • Implement a planemo conda_search command for searching best practice channels from the command line. Pull Request 642
  • Allow Planemo to work with locally built Conda packages using the --conda_use_local command. Pull Request 643, Issue 620
  • Implement an open (or just o) command to quickly open the last test results (or any file if supplied). Pull Request 641
  • Linting improvements and fixes due to galaxy-lib update. * WARN on test output names not found or not matching. * INFO correct information about stdio if profile version is found. * WARN if profile version is incorrect. * INFO profile version * Fix assert_command not detected as a valid test (fixes Issue 260).
  • Have lint --conda_requirements check that at least one actual requirement is found. 6638caa
  • Allow conda_install to work with packages as well as just tools. 8faf661
  • Add --global option to conda_install to install requirements into global Conda setup instead of using an environment. 8faf661
  • Implement planemo lint --biocontainer that checks that a tool has an available BioContainer registered. 0a1abfe
  • Add more options and more documentation to the planemo mull command. 0a1abfe
  • Hack around a bug in Conda 4.2 that makes it so planemo mull doesn’t work out of the box on Mac OS X. 0a1abfe
  • Allow URIs to be used instead of paths for a couple operations. ce0dc4e
  • Implement non-strict CWL parsing option. 4c0f100
  • Fixes for changes to cwltool and general CWL-relate functionality. 3c95b7b, 06bcf19, 525de8f, 9867e56, 9ab4a0d
  • Eliminate deprecated XML-based abstraction from planemo.tools. 04238d3
  • Fix MANIFEST.in entry that was migrated to galaxy-lib. ced5ce2
  • Various fixes for the command conda_env. Pull Request 640
  • Improved command help - both formatting and content. Pull Request 639
  • Implement a --no_dependency_resolution option disabling conda dependency resolver. Pull Request 635, Issue 633
  • Tests for new linting logic. Pull Request 638
  • Fix bug where tool IDs needs to be lowercase for the shed (thanks to @bgruening). Pull Request 649
  • Update seqtk version targetted by intro docs. e343b67
  • Various other Conda usability improvements. Pull Request 634

0.38.1 (2017-02-06)

  • Fix bug with shed_lint --urls introduced in 0.38.0. 84ebc1f

0.38.0 (2017-02-06)

0.37.0 (2017-01-25)

  • Update to the latest galaxy-lib release. This means new installs start with Miniconda 3 instead of Minicoda 2 and at a newer version. This fixes many Conda related bugs.
  • Change defaults so that Conda automatically initializes and performs tool installs by default from within the spawned Galaxy server. The trio of flags --conda_dependency_resolution, --conda_auto_install, and --conda_auto_init are effectively enabled by default now. 4595953
  • Use the Galaxy cached dependency manager by default (thanks to @abretaud). Pull Request 612
  • Test Conda dependency resolution for more versions of Galaxy including the forthcoming release of 17.01.
  • Update to the latest Galaxy tool XSD for various tool linting fixes. 32acd68
  • Fix pip ignores for bioconda_scripts (thanks to @nturaga) Pull Request 614

0.36.1 (2016-12-12)

0.36.0 (2016-12-11)

0.35.0 (2016-11-14)

0.34.1 (2016-10-12)

0.34.0 (2016-10-05)

  • Implement mull command to build containers for tools based on Conda recipes matching requirement definitions. 08cef54
  • Implement --mulled_containers flag on test, serve, and run commands to run tools in “mulled” containers. Galaxy will first search locally cache containers (such as ones built with mull), then search the mulled namespace of quay.io, and finally build one on-demand if needed using galaxy-lib and Involucro developed by @thriqon.
  • Implement --conda_requirements flag on lint command to ensure requirements can be resolved in best practice channels. 9da8387
  • Allow conda_install command over multiple tool paths. 2e4e5fc
  • Update pip as part of setting virtual environment in Makefile target. 19b2ee9
  • Add script to auto-update Bioconda recipe for Planemo and open a pull request. f0da66f

0.33.2 (2016-09-28)

  • Fix HISTORY.rst link problem that prevented correct display of content on PyPI.

0.33.1 (2016-09-28)

0.33.0 (2016-09-23)

0.32.0 (2016-09-16)

0.31.0 (2016-09-06)

  • Implement new commands to ci_find_repos and ci_find_tools to ease CI scripting. Pull Request 555

0.30.2 (2016-09-01)

  • Fix another problem with Conda prefix handling when using --conda_dependency_resolution. f7b6c7e

0.30.1 (2016-09-01)

  • Fix a problem with Conda prefix handling when using --conda_dependency_resolution. f7b6c7e
  • Fix for quote problem in update_planemo_recipe.bash. 6c03de8
  • Fix to restore linting of tests/ directory and fix import order throughout module. ef4b9f4

0.30.0 (2016-09-01)

  • Update to the latest galaxy-lib release and change Conda semantics to match recent updates to Galaxy. For the most robust Conda usage - use planemo 0.30+ with Galaxy 16.07 or master. 07d94bd
  • Implement the --conda_auto_init flag for conda_install. ca19910
  • Allow the environment variable PLANEMO_CONDA_PREFIX to set a default for --conda_prefix. 24008ab
  • Fixup documentation regarding installs and Conda. ce44e87
  • Fix and lint Python module import order throughout project. Pull Request 550
  • Use cp rather than symlink to $DOWNLOAD_CACHE in the dependency_script command (thanks to @peterjc). c2204b3
  • Fixes for the Homebrew recipe updater. c262b6d

0.29.1 (2016-08-19)

  • Improved handling of Python 2.7 specific dependencies.

0.29.0 (2016-08-19)

0.28.0 (2016-08-17)

0.27.0 (2016-06-22)

0.26.0 (2016-05-20)

  • Implement Engine and Runnable abstractions - Planemo now has beta support for testing Galaxy workflows and CWL tools with Galaxy and any CWL artifact with cwltool. Pull Request 454, 7be1bf5
  • Fix missing command_line in test output json. e38c436
  • More explicit Galaxy job_conf.xml handling, fixes bugs caused by galaxy_root having existing and incompatible job_conf.xml files and makes it possible to specify defaults with fixed server name. c4dfd55
  • Introduce profile commands (profile_create, profile_delete, and profile_list) and profile improvements (automatic postgres database creation support). Pull Request 480, a87899b
  • Rework Galaxy test reporting to use structured data instead of XUnit data. 4d29bf1
  • Refactor Galaxy configuration toward support for running Galaxy in docker-galaxy-stable. Pull Request 479

0.25.1 (2016-05-11)

0.25.0 (2016-05-11)

  • Implement Galaxy “profiles” - the ability to configure perisistent, named environments for serve and test. 5d08b67
  • Greatly improved serve command - make test-data available as an FTP folder, (on 16.07) automatically log in an admin user, and many more options (such as those required for “profiles” and a --daemon mode).
  • Two fixes to ensure more consistent, dependable test output. Pull Request 472, f3c6917
  • Add code and documentation for linting (lint) and building (tool_init) CWL tools. a4e6958, b0b867e, 4cd571c
  • If needed for Conda workaround, shorten config_directory path (thanks to @mvdbeek). efc5f30
  • Fix --no_cache_galaxy option (thanks to Gildas Le Corguillé). d8f2038
  • Target draft 3 of CWL instead of draft 2. 775bf49
  • Fix cwltool dependency version - upstream changes broke compatibility. 65b999d
  • Add documentation section and slides about recent Galaxy tool framework changes (with fix from @remimarenco). 069e7ba
  • Add IUC standards to Planemo docs. 2ae2b49
  • Improve collection-related contents in documentation (thanks in part to @martenson). fea51fc, 13a5ae7
  • Add documentation on GALAXY_SLOTS and running planemo on a cluster. 45135ff, e0acf91
  • Revise command-line handling framework for consistency and extension - allow extra options to be configured as defaults ~/.planemo.yml including --job_config_file and Conda configuration options. e769118, 26e378e
  • Fix tool_init commans options typos (thanks to Nitesh Turaga). 826d371
  • Refactor galaxy-related modules into submodules of a new planemo.galaxy package. 8e96864
  • Fix error message typo (thanks to @blankenberg). b1c8f1d
  • Update documentation for recent command additions. 3f4ab44
  • Rename option --galaxy_sqlite_database option to --galaxy_database_seed and fix it so it actually works. f7554d1
  • Add --extra_tools option to serve command. 02a08a0
  • Update project testing to include linting documentation (docs/), Python import order, and docstrings. a13a120, 6e1e726, 95d5cba

0.24.2 (2016-04-25)

  • Revert “check .shed.yml owner against credentials during shed creation”, test was incorrect and preventing uploads. Pull Request 425, Issue 246

0.24.1 (2016-04-08)

  • Fix test summary report. Pull Request 429
  • Improve error reporting when running shed_test. ce8e1be
  • Improved code comments and tests for shed related functionality. 89674cb
  • Rev galaxy-lib dependency to 16.4.1 to fix wget usage in newer versions of wget. d76b489

0.24.0 (2016-03-29)

0.23.0 (2016-02-15)

  • Fix duplicated attributes with Conda resolver (thanks to Björn Grüning). Pull Request 403
  • Upgrade to latest version of galaxy-lib for more linting.
  • Attempt to better handle conditional dependency on cwltool.

0.22.2 (2016-01-14)

  • Fixed bug targetting forthcoming release of Galaxy 16.01.

0.22.1 (2016-01-14)

  • Fixed problem with PyPI build artifacts due to submodule’s not being initialized during previous release.

0.22.0 (2016-01-13)

0.21.1 (2015-11-29)

0.21.0 (2015-11-29)

  • If virtualenv not on PATH, have Planemo create one for Galaxy. 5b97f2e
  • Add documentation section on testing tools installed in an existing Galaxy instance. 1927168
  • When creating a virtualenv for Galaxy, prefer Python 2.7. e0577e7
  • Documentation fixes and improvements thanks to @martenson. 0f8cb10, 01584c5, b757791
  • Specify a minimum six version requirement. 1c7ee5b
  • Add script to test a planemo as a wheel. 6514ff5, Issue 184
  • Fix empty macro loading. Issue 362
  • Fix an issue when you run shed_diff --shed_target local thanks to Gwendoline Andres and Gildas Le Corguillé at ABiMS Roscoff. Pull Request 375
  • Fix shed_diff printing to stdout if -o isn’t specified. f3394e7
  • Small shed_diff improvements to XML diffing and XUnit reporting. af7448c, 83e227a
  • More logging of shed_diff results if --verbose flagged. 9427b47
  • Add test_report command for rebuilding reports from structured JSON. 99ee51a
  • Fix option bug with Click 6.0 thanks to @bgruening. 2a7c792
  • Improved error messages for test commands. fdce74c
  • Various fixes for Python 3. 2f66fc3, 7572e99, 8eda729, 764ce01
  • Use newer travis container infrastructure for testing. 6d81a94
  • Test case fixes. 98fdc8c, 0e4f70a

0.20.0 (2015-11-11)

  • More complete I/O capturing for XUnit. 6409449
  • Check for select parameter without options when linting tools. Issue 373
  • Add --cwl_engine argument to cwl_run command. dd94ddc
  • Fixes for select parameter linting. 8b31850
  • Fix to demultiplexing repositories after tool uploads. Issue 361
  • Fix to update planemo for Galaxy wheels. 25ef0d5
  • Various fixes for Python 2.6 and Python 3. c1713d2, 916f610, c444855

0.19.0 (2015-11-03)

0.18.1 (2015-10-22)

  • Fix issue with test reporting not being populated. 19900a6

0.18.0 (2015-10-20)

0.17.0 (2015-10-19)

0.16.0 (2015-10-07)

0.15.0 (2015-10-01)

0.14.0 (2015-08-06)

0.13.2 (2015-07-06)

  • Fix project_init for missing files. cb5b906
  • Various documentation improvements.

0.13.1 (2015-07-01)

  • Fix for shed_init producing non-standard type hints. Issue 243, f0610d7
  • Fix tool linting for parameters that define an argument but not a name. Issue 245, aad1eed
  • Many doc updates including a tutorial for developing tools in a test-driven fashion and instructions for using the planemo appliance through Kitematic (with Kitematic screenshots from E. Rasche).

0.13.0 (2015-06-28)

  • If planemo cannot find a Galaxy root, it will now automatically fetch one (specifing --galaxy_install will still force a fetch). Pull Request 235
  • Docuementation has been updated to reflect new and vastly improved Docker and Vagrant virtual appliances are now available, as well as a new VirtualBox OVA variant.
  • Update linting for new tool XML features (including detect_errors and output collections). Issue 233, 334f2d4
  • Fix shed_test help text. Issue 223
  • Fix code typo (thanks to Nicola Soranzo). Pull Request 230
  • Improvements to algorithm used to guess if an XML file is a tool XML file. Issue 231
  • Fix configuration file handling bug. Issue 240

0.12.2 (2015-05-23)

  • Fix shed_test and shed_serve for test and local tool sheds. f3cafaa

0.12.1 (2015-05-21)

  • Fix to ensure the tab completion script is in the Python source tarball (required for setting up tab-completion for Homebrew). 6b4e7a6

0.12.0 (2015-05-21)

  • Implement a --failed flag for the test command to rerun previously faied tests. Pull Request 210
  • Implement shed_update to upload contents and update repository metadata. Pull Request 216
  • Implement shed_test and shed_serve commands to test and view published artifacts in the Tool Shed. Pull Request 213, Issue 176
  • Add shell tab-completion script. 37dcc07
  • Many more commands allow specifing multiple tool and/or repository targets. Issue 150
  • Add -m as alias for –message in planemo shed_upload (thanks to Peter Cock). Pull Request 200
  • Add --ensure_metadata option to shed_lint to ensure .shed.yml files contain many repository. Pull Request 215
  • More developer documentation, additional make targets including ones for setting up git pre-commit hooks. cc8abb6, Issue 209
  • Small README improvement (thanks to Martin Čech) b53006d
  • Fixes for shed operation error handling (thanks to Martin Čech). Pull Request 203, Pull Request 206
  • Fix for “smart” shed_diff not in the repository root directory (thanks to Peter Cock). Pull Request 207, Issue 205
  • Recursive shed_diff with directories not yet in Tool Shed. Pull Request 208
  • Improve error handling and reporting for problematic --shed_target values. Issue 217
  • Fix typos in lint messages. Issue 211

0.11.1 (2015-05-12)

  • Fix default behavior for planemo lint to use current directory if explicit paths are not supplied. 1e3668a

0.11.0 (2015-05-12)

  • More compact syntax for defining multiple custom inclusions in .shed.yml files - thanks to Peter Cock. Issue 180, Pull Request 185, Pull Request 196
  • Prevent ambigous destinations when defining custom inclusions in .shed.yml- thanks to Peter Cock. Pull Request 186
  • lint now warns if tool ids contain whitespace. Pull Request 190
  • Handle empty tar-balls gracefully on older Python versions - thanks to Peter Cock. Pull Request 187
  • Tweak quoting in cp command - thanks to Peter Cock. 6bcf699
  • Fix regression causing testing to no longer produce “pretty” test results under certain circumstances. Issue 188
  • Fix for recursive shed_diff folder naming. Issue 192
  • Fix output definitions to tool_init command. Issue 189

0.10.0 (2015-05-06)

  • Extend shed_lint to check for valid actions in tool_dependencies.xml files. 8117e03
  • Extend shed_lint to check for required files based on repository type. Issue 156
  • Ignore common editor backup files during shed_upload. Issue 179
  • Fix missing file when installing from source via PyPI. Issue 181
  • Fix lint to verify data inputs specify a format attribute. 8117e03
  • Docstring fix thanks to @peterjc. fe7ad46

0.9.0 (2015-05-03)

  • Add new logo to the README thanks to @petrkadlec from puradesign.cz and @carlfeberhard from the Galaxy Project. Issue 108
  • Implement smarter shed_diff command - it now produces a meaningful exit codes and doesn’t report differences if these correspond to attributes that will be automatically populated by the Tool Shed. Issue 167
  • Use new smarter shed_diff code to implement a new --check_diff option for shed_upload - to check for meaningful differences before updating repositories. Issue 168
  • Record git commit hash during shed_upload if the .shed.yml is located in a git repository. Issue 170
  • Allow shed_ operations to operate on git URLs directly. Issue 169
  • Fail if missing file inclusion statements encountered during .shed.yml repository resolution - bug reported by @peterjc. Issue 158
  • Improved exception handling for tool shed operations including new --fail_fast command-line option. * Issue 114, Pull Request 173
  • Implement more validation when using the shed_init command. 1cd0e2d
  • Add -r/--recursive option to shed_download and shed_diff commands and allow these commands to work with .shed.yml files defining multipe repositories. 40a1f57
  • Add --port option to the serve and tool_factory commands. 15804be
  • Fix problem introduced with setup.py during the 0.9.0 development cycle - thanks to @peterjc. Pull Request 171
  • Fix clone bug introduced during 0.9.0 development cycle - thanks to @bgruening. Pull Request 175

0.8.4 (2015-04-30)

0.8.3 (2015-04-29)

  • Fix bug where shed_lint was not respecting the -r/--recursive flag. 9ff0d2d
  • Fix bug where planemo was producing tar files incompatible with the Tool Shed for package and suite repositories. a2ee135

0.8.2 (2015-04-29)

0.8.1 (2015-04-28)

  • Fixes for the source distribution to allow installation of 0.8.0 via Homebrew.

0.8.0 (2015-04-27)

  • Implement the new shed_lint command that verifies various aspects of tool shed repositories - including XSD validation of repository_dependencies.xml and tool_dependencies.xml files, best practices for README files, and the contents of .shed.yml files. This requires the lxml library to be available to Planemo or the application xmllint to be on its PATH. Pull Request 130 Issue 89 Issue 91 912df02 d26929e 36ac6d8
  • Option to enable experimental XSD based validation of tools when lint is executed with the new --xsd flag. This validation occurs against the unofficial Galaxy Tool XSD project maintained by @JeanFred. This requires the lxml library to be available to Planemo or the application xmllint to be on its PATH. Pull Request 130 912df02
  • Allow skipping specific linters when using the lint command using the new --skip option. 26e3cdb
  • Implement sophisticated options in .shed.yml to map a directory to many, custom Tool Shed repositories during shed operaitons such shed_upload including automatically mapping tools to their own directories and automatically building suites repositories. Pull Request 143
  • Make shed_upload more intelligent when building tar files so that package and suite repositories may have README files in source control and they will just be filtered out during upload. 53edd99
  • Implement a new shed_init command that will help bootstrap .shed.yml files in the specified directory. cc1a447
  • Extend shed_init to automatically build a repository_rependencies.xml file corresponding to a Galaxy workflow (.ga file). Issue 118 988de1d
  • In addition to a single file or directory, allow lint to be passed multiple files. 343902d Issue 139
  • Add -r/--recursive option to shed_create and lint commands. 63cd431 01f2af9
  • Improved output formatting and option to write diffs to a file for the shed_diff command. 965511d
  • Fix lint problem when using new Galaxy testing features such as expecting job failures and verifing job output. Issue 138
  • Fix typo in test help thanks to first time contributor @pvanheus. Pull Request 129 1982076
  • Fix NPE on empty help element when linting tools. Issue 124
  • Fix lint warnings when configfiles are defined in a tool. 1a85493
  • Fix for empty .shed.yml files. b7d9e96
  • Fix the test command for newer versions of nose. 33294d2
  • Update help content and documentation to be clear normalize should not be used to update the contents of tool files at this time. 08de8de
  • Warn on unknown command attributes when linting tools (anything but interpreter). 4f61025
  • Various design, documentation (including new documentation on Tool Shed publishing), and testing related improvements (test coverage has risen from 65% to over 80% during this release cycle).

0.7.0 (2015-04-13)

  • Implement shed_create command to create Tool Shed repositories from .shed.yml files (thanks to E. Rasche). Pull Request 101
  • Allow automatic creation of missing repositories during shed_upload with the new --force_repository_creation flag (thanks to E. Rasche). Pull Request 102
  • Allow specifying files to exclude in .shed.yml when creating tar files for shed_upload (thanks to Björn Grüning). Pull Request 99
  • Resolve symbolic links when building Tool Shed tar files with shed_upload (thanks to Dave Bouvier). Pull Request 104
  • Add a Contributor Code of Conduct. Pull Request 113
  • Omit tool_test_output.json from Tool Shed tar file created with shed_upload (thanks to Dave Bouvier). Pull Request 111
  • Update required version of bioblend to 0.5.3. Fixed Issue 88.
  • Initial work on implementing tests cases for Tool Shed functionality. 182fe57
  • Fix incorrect link in HTML test report (thanks to Martin Čech). 4c71299
  • Download Galaxy from the new, official Github repository. 7c69bf6
  • Update travis_test to install stable planemo from PyPI. 39fedd2
  • Enable caching on --install_galaxy by default (disable with --no_cache_galaxy). d755fe7

0.6.0 (2015-03-16)

  • Many enhancements to the tool building documentation - descriptions of macros, collections, simple and conditional parameters, etc…
  • Fix tool_init to quote file names (thanks to Peter Cock). Pull Request 98.
  • Allow ignoring file patterns in .shed.yml (thanks to Björn Grüning). Pull Request 99
  • Add --macros flag to tool_init command to generate a macro file as part of tool generation. ec6e30f
  • Add linting of tag order for tool XML files. 4823c5e
  • Add linting of stdio tags in tool XML files. 8207026
  • More tests, much higher test coverage. 0bd4ff0

0.5.0 (2015-02-22)

  • Implement --version option. Issue 78
  • Implement --no_cleanup option for test and serve commands to persist temp files. 2e41e0a
  • Fix bug that left temp files undeleted. Issue 80
  • More improvements to release process. fba3874

0.4.2 (2015-02-21)

  • Fix setup.py for installing non-Python data from PyPI (required newer for tool_factory command and reStructuredText linting). Thanks to Damion Dooley for the bug report. Issue 83

0.4.1 (2015-02-16)

  • Fix README.rst so it renders properly on PyPI.

0.4.0 (2015-02-16)

  • Implement tool_init command for bootstrapping creation of new tools (with tutorial.) 78f8274
  • Implement normalize command for reorganizing tool XML and macro debugging. e8c1d45
  • Implement tool_factory command to spin up Galaxy pre-configured the Tool Factory. 9e746b4
  • Added basic linting of command blocks. b8d90ab
  • Improved linting of help blocks, including verifying valid reStructuredText. 411a8da
  • Fix bug related to serve command not killing Galaxy properly when complete. 53a6766
  • Have serve command display tools at the top level instead of in shallow sections. badc25f
  • Add additional dependencies to setup.py more functionality works out of the box. 85b9614
  • Fix terrible error message related to bioblend being unavailable. Issue 70
  • Various smaller documentation and project structure improvements.

0.3.1 (2015-02-15)

  • Fixes to get PyPI workflow working properly.

0.3.0 (2015-02-13)

  • Add option (-r) to the shed_upload command to recursively upload subdirectories (thanks to E. Rasche). Pull Request 68
  • Fix diff formatting in test reports (thanks to E. Rasche). Pull Request 63
  • Grab updated test database to speed up testing (thanks to approach from E. Rasche and Dannon Baker). Issue 61, dff4f33
  • Fix test data command-line argument name (was test-data now it is test_data). 834bfb2
  • Use tool_data_table_conf.xml.sample file if tool_data_table_conf.xml.test is unavailable. Should allow some new tools to be tested without modifying Galaxy’s global tool_data_table_conf.xml file. ac4f828

0.2.0 (2015-01-13)

  • Improvements to way Planemo loads its own copy of Galaxy modules to prevent various conflicts when launching Galaxy from Planemo. Pull Request 56
  • Allow setting various test output options in ~/.planemo.yml and disabling JSON output. 21bb463
  • More experimental Brew and Tool Shed options that should not be considered part of Planemo’s stable API. See bit.ly/gxbrew1 for more details.
  • Fix project_init for BSD tar (thanks to Nitesh Turaga for the bug report.) a4110a8
  • Documentation fixes for tool linting command (thanks to Nicola Soranzo). Pull Request 51

0.1.0 (2014-12-16)

  • Moved repository URL to https://github.com/galaxyproject/planemo.
  • Support for publishing to the Tool Shed. Pull Request 6
  • Support for producing diffs (shed_diff) between local repositories and the Tool Shed (based on scripts by Peter Cock). Pull Request 33
  • Use tool’s local test data when available - add option for configuring test-data target. Pull Request 1
  • Support for testing tool features dependent on cached data. 44de95c
  • Support for generating XUnit tool test reports. 82e8b1f
  • Prettier HTML reports for tool tests. 05cc9f4
  • Implement share_test command for embedding test result links in pull requests. Pull Request 40
  • Fix for properly resolving links during Tool Shed publishing (thanks to Dave Bouvier). Pull Request 29
  • Fix for citation linter (thanks to Michael Crusoe for the bug report). af39061
  • Fix tool scanning for tool files with fewer than 10 lines (thanks to Dan Blankenberg). a2c13e4
  • Automate more of Travis CI testing so the scripts added to tool repository can be smaller. 20a8680
  • Documentation fixes for Travis CI (thanks to Peter Cock). Pull Request 22, Pull Request 23
  • Various documentation fixes (thanks to Martin Čech). 36f7cb1, b9232e5
  • Various smaller fixes for Docker support, tool linting, and documentation.

0.0.1 (2014-10-04)

  • Initial work on the project - commands for testing, linting, serving Galaxy tools - and more experimental features involving Docker and Homebrew. 7d07782

Project details

Project links

Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Academic Free License (AFL) (AFL)

Author: Galaxy Project and Community

Tags planemo

Maintainers

Avatar for bgruening from gravatar.com bgruening Avatar for jmchilton from gravatar.com jmchilton Avatar for mvdbeek from gravatar.com mvdbeek Avatar for natefoo from gravatar.com natefoo Avatar for nsoranzo from gravatar.com nsoranzo

Classifiers


Release history Release notifications

This version

0.70.0

0.63.0

0.62.1

0.61.0

0.60.0

0.59.0

0.58.2

0.58.1

0.58.0

0.57.1

0.57.0

0.56.0

0.55.0

0.54.0

0.53.0

0.52.0

0.51.0

0.50.1

0.50.0

0.49.2

0.49.1

0.49.0

0.48.0

0.47.0

0.46.1

0.46.0

0.45.0

0.44.0

0.43.0

0.42.1

0.42.0

0.41.0

0.40.1

0.40.0

0.39.0

0.38.1

0.38.0

0.37.0

0.36.1

0.36.0

0.35.0

0.34.1

0.34.0

0.33.2

0.33.1

0.33.0

0.32.0

0.31.0

0.30.2

0.30.1

0.30.0

0.29.1

0.29.0

0.28.0

0.27.0

0.26.0

0.25.1

0.25.0

0.24.2

0.24.1

0.24.0

0.23.0

0.22.2

0.22.1

0.22.0

0.21.1

0.21.0

0.20.0

0.19.0

0.18.1

0.18.0

0.17.0

0.16.0

0.15.0

0.14.0

0.13.2

0.13.1

0.13.0

0.12.2

0.12.1

0.12.0

0.11.1

0.11.0

0.10.0

0.9.0

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.0

0.6.0

0.5.0

0.5.0.dev0 pre-release

0.4.2

0.4.1

0.4.0

0.3.1

0.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for planemo, version 0.70.0
Filename, size File type Python version Upload date Hashes
Filename, size planemo-0.70.0-py2.py3-none-any.whl (324.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size planemo-0.70.0.tar.gz (355.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page