Skip to content

Commit

Permalink
Tag for release
Browse files Browse the repository at this point in the history
  • Loading branch information
illusional committed Mar 1, 2019
1 parent be63fdd commit 6d0a758
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@
### WARNING

This module now only generates developmental WDL, this includes Directories and wrapping all inputs in an input block.
To use this generated WDL, you must use a version of Cromwell higher than 37.
To use this generated WDL, you must use a version of **Cromwell higher than 37**.

This module automatically includes `version development` in the Workflow and Task outputs.
The guides below may not reflect the current version of this repository, but will be updated soon.

This syntax is based on the [Developmental Workflow Description Language specification](https://github.com/openwdl/wdl/blob/master/versions/development/SPEC.md).

___

## Motiviation

I needed an easy way to generate some _BASIC_ WDL through some in memory objects, and I was using ([a fork](https://github.com/illusional/python-cwlgen) of) [common-workflow-language/python-cwlgen](https://github.com/common-workflow-language/python-cwlgen), I figured I could open this up to see what use it has.
Expand Down Expand Up @@ -124,8 +126,12 @@ echo \

The combination of the task and command outputs:
```wdl
version development
task task_name {
String taskGreeting
input {
String taskGreeting
}
command {
echo \
-a ${taskGreeting} \
Expand Down Expand Up @@ -158,10 +164,14 @@ w.outputs.append(wdlgen.Output(wdlgen.WdlType.parse("File"), "standardOut", "tas

Which outputs:
```wdl
version development

import "tools/tool_file.wdl"

workflow workflow_name {
String inputGreeting
input {
String inputGreeting
}
call Q.namspaced_task_identifier as task_alias {
input:
taskGreeting=inputGreeting
Expand All @@ -184,9 +194,10 @@ You could also cause syntax errors in generated WDL by providing illegal charact
- Improve code-level documentation.
- Increase the testing coverage + quality of unit tests.
- Better represent the WDL spec.
- Find an easier distribution / release method - such as PIP.
- Automate testing and delivery through TravisCI / CircleCI or similar.
- ~~Find an easier distribution / release method - such as PIP.~~
- ~~Automate testing and delivery through TravisCI / CircleCI or similar.~~
- Validate each value by [WDL's language specifications](https://github.com/openwdl/wdl/blob/master/versions/1.0/SPEC.md#language-specification).
- Add support for structs

### Long goals
- Write a documentation site.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from setuptools import setup

__version__ = "v0.0.2"
__version__ = "v0.1.0"

DESCRIPTION = "Contains classes and helpers to generate WDL without worrying about the syntax. " \
"This is primarily intended for generating WDL from other in-memory representations of a workflow."
Expand Down

0 comments on commit 6d0a758

Please sign in to comment.