17 Commits
v2.0 ... cli

Author SHA1 Message Date
f9cc1d93f2 travis.yml: python 3.7 -> 3.7-dev 2019-01-17 13:15:53 -08:00
09417f7c23 remove unused import 2019-01-17 11:43:21 -08:00
cf4145aee5 python version >= 3.5 2019-01-17 11:41:59 -08:00
98ef3fa49a add shields 2019-01-17 11:41:45 -08:00
4b69492d40 change newline to trigger travis 2019-01-17 11:36:40 -08:00
c8e1760470 add .travis.yml 2019-01-17 11:33:17 -08:00
861dc16a64 banana -> bananas. update gitignore. 2019-01-17 11:24:36 -08:00
fc0479ff77 clean up after test 2019-01-17 11:24:04 -08:00
dae3b1dd45 fix tests and fix the way we are looking for param and config files (use os.getcwd()) 2019-01-17 11:19:32 -08:00
88cd2f71a6 update gh-pages url in setup.py 2019-01-17 11:18:47 -08:00
6c29958c13 manifest should include files, not graft them (graft is for directories) 2019-01-17 10:44:37 -08:00
682f760c10 update readme instructions 2019-01-17 10:07:24 -08:00
742f24d0e5 include Snakefile with Manifest.in to make it run automagically 2019-01-16 23:26:01 -08:00
abd4a07dec move config and params to test/ 2019-01-16 23:16:12 -08:00
48f4d30903 add Snakefile to manifest 2019-01-16 23:16:04 -08:00
a908ddf8c2 update how/where we look for Snakefile 2019-01-16 23:15:18 -08:00
71f48e0f5e convert 2018-snakemake-cli to python package (setup.py)
converts the simple example in 2018-snakemake-cli,
which used a shell script sitting in a directory to
run the Snakemake workflow, into a full-fledged
python package that uses a setup.py file.

this is a way of bridging the complexity of taco
with the simplicity of 2018-snakemake-cli.

documentation/readme has not yet been updated.

tests have not yet been udpated.
2019-01-16 22:58:09 -08:00
3 changed files with 9 additions and 17 deletions

View File

@@ -3,7 +3,7 @@ language: python
python:
- "3.5"
- "3.6"
#- "3.7-dev" # fails due to datrie build failure (snakemake dependency)
- "3.7-dev"
# command to install dependencies
install:
- pip install -r requirements.txt
@@ -11,4 +11,3 @@ install:
# command to run tests
script:
- pytest

View File

@@ -1,6 +1,6 @@
# 2019-snakemake-cli
[![travis](https://img.shields.io/travis/charlesreid1/2019-snakemake-cli.svg)](https://travis-ci.org/charlesreid1/2019-snakemake-cli)
[![travis](https://img.shields.io/travis/charlesreid1/2019-snakemake-cli.svg)](https://travis-ci.org/charlesreid1/2019-snakemake-cli.svg)
[![license](https://img.shields.io/github/license/charlesreid1/2019-snakemake-cli.svg)](https://github.com/charlesreid1/2019-snakemake-cli/blob/master/LICENSE)
An example of a Snakemake command line interface
@@ -18,7 +18,7 @@ a command line tool called `bananas`.
This runs through the installation and usage
of 2019-snakemake-cli.
## Installing bananas
## Installing banana
Start by setting up a virtual environment,
and install the required packages into the
@@ -37,13 +37,13 @@ python setup.py build install
Now you can run
```
which bananas
which banana
```
and you should see `bananas` in your virtual
environment's `bin/` directory.
and you should see `bananas` in your Python
distribution's `bin/` directory.
## Running bananas
## Running banana
Move to the `test/` directory and run the tests
with the provided config and params files.
@@ -66,7 +66,7 @@ Run the goodbye workflow with Beth params:
```
rm -f goodbye.txt
bananas workflow-goodbye params-beth
./run workflow-goodbye params-beth
```
# Details
@@ -80,10 +80,3 @@ An alternative arrangement would be for users
to provide a Snakefile via rules in the working
directory, or via a Github URL or a remote URL.
# Tags
* `v1.0` - initial version, [ctb/2018-snakemake-cli](https://github.com/ctb/2018-snakemake-cli)
* `v2.0` - Snakemake workflow bundled as installable Python package, Snakefile bundled with
Python package, command line interface provided to wrap Snakemake API call

View File

@@ -8,7 +8,7 @@ gitdb2==2.0.5
GitPython==2.1.11
idna==2.8
jsonschema==2.6.0
PyYAML>=4.2b1
PyYAML==3.13
ratelimiter==1.2.0.post0
requests==2.21.0
smmap2==2.0.5