|
1 | 1 | # gxwf |
2 | 2 |
|
3 | | -CLI tool for running Galaxy workflows |
4 | | - |
5 | | -## Project Features |
6 | | - |
7 | | -* [gxwf](http://gxwf.readthedocs.io/) |
8 | | -* a starter [Click](http://click.pocoo.org/5/) command-line application |
9 | | -* automated unit tests you can run with [pytest](https://docs.pytest.org/en/latest/) |
10 | | -* a [Sphinx](http://www.sphinx-doc.org/en/master/) documentation project |
11 | | - |
12 | | -## Getting Started |
13 | | - |
14 | | -The project's documentation contains a section to help you |
15 | | -[get started](https://gxwf.readthedocs.io/en/latest/getting_started.html) as a developer or |
16 | | -user of the library. |
17 | | - |
18 | | -## Development Prerequisites |
19 | | - |
20 | | -If you're going to be working in the code (rather than just using the library), you'll want a few utilities. |
21 | | - |
22 | | -* [GNU Make](https://www.gnu.org/software/make/) |
23 | | -* [Pandoc](https://pandoc.org/) |
24 | | - |
25 | | -## Resources |
26 | | - |
27 | | -Below are some handy resource links. |
28 | | - |
29 | | -* [Project Documentation](http://gxwf.readthedocs.io/) |
30 | | -* [Click](http://click.pocoo.org/5/) is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. |
31 | | -* [Sphinx](http://www.sphinx-doc.org/en/master/) is a tool that makes it easy to create intelligent and beautiful documentation, written by Geog Brandl and licnsed under the BSD license. |
32 | | -* [pytest](https://docs.pytest.org/en/latest/) helps you write better programs. |
33 | | -* [GNU Make](https://www.gnu.org/software/make/) is a tool which controls the generation of executables and other non-source files of a program from the program's source files. |
34 | | - |
35 | | - |
36 | | -## Authors |
37 | | - |
38 | | -* **Simon Bray** - *Initial work* - [github](https://github.com/simonbray) |
39 | | - |
40 | | -See also the list of [contributors](https://github.com/simonbray/gxwf/contributors) who participated in this project. |
41 | | - |
42 | | -## LicenseMIT License |
43 | | - |
44 | | -Copyright (c) simonbray |
45 | | - |
46 | | -Permission is hereby granted, free of charge, to any person obtaining a copy |
47 | | -of this software and associated documentation files (the "Software"), to deal |
48 | | -in the Software without restriction, including without limitation the rights |
49 | | -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
50 | | -copies of the Software, and to permit persons to whom the Software is |
51 | | -furnished to do so, subject to the following conditions: |
52 | | - |
53 | | -The above copyright notice and this permission notice shall be included in all |
54 | | -copies or substantial portions of the Software. |
55 | | - |
56 | | -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
57 | | -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
58 | | -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
59 | | -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
60 | | -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
61 | | -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
62 | | -SOFTWARE. |
| 3 | +Deprecated CLI tool for running Galaxy workflows - use `planemo run` instead: https://github.com/galaxyproject/planemo/ |
0 commit comments