Skip to content
This repository was archived by the owner on Jun 9, 2020. It is now read-only.

Commit f2625d5

Browse files
committed
Fix README for push back to original cwlgen repo
1 parent eb2f74c commit f2625d5

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# python-cwlgen
22

3-
(From original repository)
4-
53
[![Build Status](https://travis-ci.org/common-workflow-language/python-cwlgen.svg?branch=master)](https://travis-ci.org/common-workflow-language/python-cwlgen)
64
[![codecov](https://codecov.io/gh/common-workflow-language/python-cwlgen/branch/master/graph/badge.svg)](https://codecov.io/gh/common-workflow-language/python-cwlgen)
75
[![Documentation Status](https://readthedocs.org/projects/python-cwlgen/badge/?version=latest)](http://python-cwlgen.readthedocs.io/en/latest/?badge=latest)
@@ -27,20 +25,20 @@ The [user guide](http://www.commonwl.org/user_guide/01-introduction/index.html)
2725
This python repository is a python wrapper for _most_ of the classes (work in progress),
2826
allowing you to build the structure of the workflow in Python and have this module generate and export CWL for you.
2927

30-
**Nb:** This isn't going to sanity or quality check Workflows or CommandLineTools for you, use
31-
[CWLTool](https://github.com/common-workflow-language/cwltool) or [WOMTool](https://cromwell.readthedocs.io/en/develop/WOMtool/) for that.
28+
**Nb:** This doesn't check the logic of Workflows or CommandLineTools for you.
29+
[CWLTool](https://github.com/common-workflow-language/cwltool) has a `--validate` mode that you can use.
3230

3331
## Quick-start guide
3432

3533
You can install python-cwlgen through pip with the following command:
3634

37-
```
35+
```bash
3836
pip install cwlgen
3937
```
4038

41-
## How it works ?
39+
### How it works ?
4240

43-
There's a pretty close copy of the cwl specifications ([Workflow](https://www.commonwl.org/v1.0/Workflow.html)|
41+
There's a copy of the cwl specifications ([Workflow](https://www.commonwl.org/v1.0/Workflow.html)|
4442
[CommandLineTool](https://www.commonwl.org/v1.0/CommandLineTool.html)), where the Python classes mirror the CWL spec.
4543
This repository also includes docstrings to give you context of classes and their properties.
4644

test/test_unit_requirements.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def test_export(self):
4444

4545
def test_export_without_lib(self):
4646
tool = self.js_req_nolib.get_dict()
47-
self.assertEqual(tool, {})
47+
self.assertDictEqual(tool, {})
4848

4949

5050
class TestDockerRequirement(unittest.TestCase):
@@ -82,7 +82,7 @@ def test_export(self):
8282

8383
def test_missing_export(self):
8484
dr = cwlgen.DockerRequirement()
85-
self.assertEqual(dr.get_dict(), {})
85+
self.assertDictEqual(dr.get_dict(), {})
8686

8787

8888
class TestSubworkflowFeatureRequirement(unittest.TestCase):
@@ -95,7 +95,7 @@ def test_init(self):
9595

9696
def test_add(self):
9797
tool = self.req.get_dict()
98-
self.assertEqual(tool, {})
98+
self.assertDictEqual(tool, {})
9999

100100

101101
class TestSoftwareRequirement(unittest.TestCase):

0 commit comments

Comments
 (0)