Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
f3b60856c2 | |||
96821aa1db | |||
c4fe27e883 | |||
7da5a5e4ba | |||
05816b006d | |||
31e2d0c3e1 | |||
d013ff2ddd |
@@ -3,7 +3,7 @@ language: python
|
|||||||
python:
|
python:
|
||||||
- "3.5"
|
- "3.5"
|
||||||
- "3.6"
|
- "3.6"
|
||||||
- "3.7-dev"
|
#- "3.7-dev" # fails due to datrie build failure (snakemake dependency)
|
||||||
# command to install dependencies
|
# command to install dependencies
|
||||||
install:
|
install:
|
||||||
- pip install -r requirements.txt
|
- pip install -r requirements.txt
|
||||||
@@ -11,3 +11,4 @@ install:
|
|||||||
# command to run tests
|
# command to run tests
|
||||||
script:
|
script:
|
||||||
- pytest
|
- pytest
|
||||||
|
|
||||||
|
21
README.md
21
README.md
@@ -1,6 +1,6 @@
|
|||||||
# 2019-snakemake-cli
|
# 2019-snakemake-cli
|
||||||
|
|
||||||
[](https://travis-ci.org/charlesreid1/2019-snakemake-cli.svg)
|
[](https://travis-ci.org/charlesreid1/2019-snakemake-cli)
|
||||||
[](https://github.com/charlesreid1/2019-snakemake-cli/blob/master/LICENSE)
|
[](https://github.com/charlesreid1/2019-snakemake-cli/blob/master/LICENSE)
|
||||||
|
|
||||||
An example of a Snakemake command line interface
|
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
|
This runs through the installation and usage
|
||||||
of 2019-snakemake-cli.
|
of 2019-snakemake-cli.
|
||||||
|
|
||||||
## Installing banana
|
## Installing bananas
|
||||||
|
|
||||||
Start by setting up a virtual environment,
|
Start by setting up a virtual environment,
|
||||||
and install the required packages into the
|
and install the required packages into the
|
||||||
@@ -37,13 +37,13 @@ python setup.py build install
|
|||||||
Now you can run
|
Now you can run
|
||||||
|
|
||||||
```
|
```
|
||||||
which banana
|
which bananas
|
||||||
```
|
```
|
||||||
|
|
||||||
and you should see `bananas` in your Python
|
and you should see `bananas` in your virtual
|
||||||
distribution's `bin/` directory.
|
environment's `bin/` directory.
|
||||||
|
|
||||||
## Running banana
|
## Running bananas
|
||||||
|
|
||||||
Move to the `test/` directory and run the tests
|
Move to the `test/` directory and run the tests
|
||||||
with the provided config and params files.
|
with the provided config and params files.
|
||||||
@@ -66,7 +66,7 @@ Run the goodbye workflow with Beth params:
|
|||||||
|
|
||||||
```
|
```
|
||||||
rm -f goodbye.txt
|
rm -f goodbye.txt
|
||||||
./run workflow-goodbye params-beth
|
bananas workflow-goodbye params-beth
|
||||||
```
|
```
|
||||||
|
|
||||||
# Details
|
# Details
|
||||||
@@ -80,3 +80,10 @@ An alternative arrangement would be for users
|
|||||||
to provide a Snakefile via rules in the working
|
to provide a Snakefile via rules in the working
|
||||||
directory, or via a Github URL or a remote URL.
|
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
|
||||||
|
|
||||||
|
@@ -8,7 +8,7 @@ gitdb2==2.0.5
|
|||||||
GitPython==2.1.11
|
GitPython==2.1.11
|
||||||
idna==2.8
|
idna==2.8
|
||||||
jsonschema==2.6.0
|
jsonschema==2.6.0
|
||||||
PyYAML==3.13
|
PyYAML>=4.2b1
|
||||||
ratelimiter==1.2.0.post0
|
ratelimiter==1.2.0.post0
|
||||||
requests==2.21.0
|
requests==2.21.0
|
||||||
smmap2==2.0.5
|
smmap2==2.0.5
|
||||||
|
Reference in New Issue
Block a user