biocore/burrito

Python framework for controlling command-line applications.

burrito's Issues

add logo

@ebolyen assigning to you

Examples?

First, the README is a bit too light, it says the goal is to wrap and control CLI apps, but it doesn't tell which aspects are wrapped and controlled. Also, the only documentation is docstrings on classes. It is good when you use the lib, but not enough for introducing the lib.
There should be at least an example program using this lib, like a "hello, world", demonstrating what burrito can do, and how it should be used.

improve temp file handling and remove references to /tmp

This issue was originally posted on the scikit-bio issue tracker here; see discussion there for details.

port application framework documentation

Port the application controller documentation that's hosted here.

should take advantage of shlex module

future of burrito?

Some questions were brought up in #15 about the future of this project. It hasn't been actively maintained for a little while now. The initial goals were to be able to input and output Python objects to/from command line applications (which it does well), but given that QIIME 1 was so file-focused, we didn't make a lot of use of this functionality then (so is probably overly complex for QIIME 1's needs). Input/output of objects in QIIME 2, where there is a central focus on the API, may be useful but there may also be more recent alternatives (ideally that we wouldn't have to maintain ourselves).

Note that burrito is free to evolve in its functionality and API, but future versions that change the API must be released under version >= 1.0.0 (as we've promised to keep the API stable for burrito >= 0.9.1, < 1.0.0 and burrito-fillings >= 0.1.1, < 0.2.0.

If we do continue maintaining this in the future, I would like someone else to take the role of primary maintainer/owner moving forward.

So:

Are you currently using burrito? If so, what features? Are there alternatives that you're aware of? Would you be interested in maintaining burrito in the future (including reviewing pull requests on this project and on burrito-fillings)?