Command-line utilities to assist in building tools for the Galaxy project (http://galaxyproject.org/).
Project description
Command-line utilities to assist in building tools for the Galaxy project.
Free software: Academic Free License version 3.0
Documentation: https://planemo.readthedocs.org.
Quick Start
This quick start demonstrates using planemo commands to help develop Galaxy tools. Planemo can quickly be installed via Homebrew or as a more traditional Python project.
To install using Homebrew or linuxbrew:
brew tap galaxyproject/tap brew install planemo
For a more traditional Python installation simply setup a virtualenv for planemo (this example creates a new one in .venv) and then install with pip.
% virtualenv .venv; . .venv/bin/activate % pip install planemo
Planemo is also available a virtual appliance for Docker or Vagrant (bundled with a preconfigured Galaxy server optimized for tool development).
This quick start will assume you will have a directory with one or more tool XML files. If none is available, one can be quickly create for demonstrating planemo as follows mkdir mytools; cd mytools; planemo project_init --template=demo.
Planemo can check tools containing XML 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 other tool files or a directory of tool files.
% planemo l randomlines.xml
The lint command takes in a additional options related to reporting levels, exit code, etc…. These options are descirbed here or (like all available commands) be accessed by passing it --help.:
% planemo l --help Usage: planemo lint [OPTIONS] TOOL_PATH ...
Once tools are syntically correct - it is time to test. The test command can be used to test a tool or directory of tools.:
% planemo test --galaxy_root=../galaxy-central randomlines.xml
If no --galaxy_root is defined, planemo will check for a default in ~/.planemo.yml) and finally search the tool’s parent directories for a Galaxy root directory (developing tools under Galaxy tools directory is a common development workflow). Planemo can also download and configure a disposable Galaxy instance just for testing by passing it -install_galaxy instead of a Galaxy root.:
% planemo t --install_galaxy
Warning: The features of Planemo that require a --galaxy_root will only work with Galaxy releases from 2015.
Planemo will create a HTML an output report in the current directory named tool_test_output.html (override with --test_output). Here is 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.
Finally, when tools are ready to be published to GitHub, it may be valuable to setup contineous integration to test changes committed and new pull requests. Travis CI is a service providing free testing and deep integration with GitHub.
The travis_init command will bootstrap a project with files to ease contineous inegration of tools using a Planemo driven approach inspired by this great blog post by Peter Cock.
% planemo travis_init . % # setup Ubuntu 12.04 w/tool dependencies % vim .travis/setup_custom_dependencies.bash % git add .travis.yml .travis % git commit -m "Add Travis CI testing infrastructure for tools." % git push # and register repository @ http://travis-ci.org/
Experimental Features
While Planemo is very experimental itself - it can also be used to explore some more experimental features related to Galaxy tooling - including support for Docker and Brew.
Docker
Galaxy has experimental support for running jobs in Docker containers. Planemo contains tools to assist in development of Docker images for Galaxy tools.
A shell can be launched to explore the Docker enviornment referenced by tools that are annotated with publically registered Docker images.:
% $(planemo docker_shell bowtie2.xml)
For Docker containers still in development - a Dockerfile can be associated with a tool by sticking it in the tool’s directory. Planemo can then build and tag a Docker image for this tool and launch a shell into it using the following commands.:
% planemo docker_build bowtie2.xml # asssumes Dockerfile in same dir % $(planemo docker_shell --from_tag bowtie2.xml)
For more details see the documentation for the docker_build and docker_shell commands.
Brew
The Galaxy development team is exploring different options for integrating Homebrew and linuxbrew with Galaxy. One angle is resolving the tool requirements using brew. An experimental approach for versioning of brew recipes will be used. See full discussion on the homebrew-science issues page here - https://github.com/Homebrew/homebrew-science/issues/1191. Information on the implementation can be found https://github.com/jmchilton/platform-brew until a more permanent project home is setup.
% planemo brew_init # install linuxbrew (only need if not already installed) % planemo brew # install dependencies for all tools in directory. % planemo brew bowtie2.xml # install dependencies for one tool % which bowtie2 bowtie2 not found % . <(planemo brew_env --shell bowtie2.xml) # shell w/brew deps resolved (bowtie2) % which bowtie2 /home/john/.linuxbrew/Cellar/bowtie2/2.1.0/bin/bowtie2 (bowtie2) % exit % . <(planemo brew_env bowtie2.xml) # or just source deps in cur env % which bowtie2 /home/john/.linuxbrew/Cellar/bowtie2/2.1.0/bin/bowtie2
For more information see the documentation for the brew and brew_env commands.
History
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)
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 Eric Rasche). Pull Request 68
Fix diff formatting in test reports (thanks to Eric Rasche). Pull Request 63
Grab updated test database to speed up testing (thanks to approach from Eric 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). 36f7cb11, b9232e55
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file planemo-0.6.0.tar.gz.
File metadata
- Download URL: planemo-0.6.0.tar.gz
- Upload date:
- Size: 172.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 67bf6d0a166b694e9cdebac68eeff81ce2934504d61596fd831382e14c736095 |
|
| MD5 | 1e1efc208b8fea7d86c731943682d250 |
|
| BLAKE2b-256 | a00580551a33c341259ce60f456dc833bdbd510a7b93a31df4ec4da3c4726258 |
File details
Details for the file planemo-0.6.0-py2.py3-none-any.whl.
File metadata
- Download URL: planemo-0.6.0-py2.py3-none-any.whl
- Upload date:
- Size: 180.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56019c67df650cb4362d8e9b4084877271525fd2680d0193581c7a7e63b8cf90 |
|
| MD5 | e59dd98224531b315699f6893807d960 |
|
| BLAKE2b-256 | bd10dc49293ec8b007f112995b280f41fd3fb0427b910bdaa5ebc253664f8df8 |
File details
Details for the file planemo-0.6.0-py2.7.egg.
File metadata
- Download URL: planemo-0.6.0-py2.7.egg
- Upload date:
- Size: 302.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ba6ece5d8691bfab9e7537b8df0ab6b8011885c6fce44bb11a089c8bf356ddda |
|
| MD5 | 58ea111cabcecc507826178873183751 |
|
| BLAKE2b-256 | a340895630c7a759b7e241bf41bb999e420970ec1244741e95c398336d93782a |
