Merge pull request #5 from giannisdoukas/dev

Dev

Author: giannisdoukas

.gitignore

@@ -244,4 +244,5 @@ cython_debug/
 /tests/jn/output/
 tmp.py
 /html/
-cwlbuild
+cwlbuild
+/tests/repo-like/result.yaml

.travis.yml

@@ -13,6 +13,8 @@ install:
   - pip install -r test-requirements.txt
   - python setup.py install
   - pip freeze
+  # there is a issue in repo2docker in travis. fix file permission
+  - chmod +x $(python -c "import repo2docker; print(repo2docker.__file__[:-11])")/buildpacks/repo2docker-entrypoint
 script:
   - pycodestyle --max-line-length=119 $(find ipython2cwl -name '*.py')
   - coverage run --source ipython2cwl -m unittest discover tests

README.md

@@ -3,9 +3,10 @@
 [![Build Status](https://travis-ci.com/giannisdoukas/ipython2cwl.svg)](https://travis-ci.com/giannisdoukas/ipython2cwl)
 [![Coverage Status](https://coveralls.io/repos/github/giannisdoukas/ipython2cwl/badge.svg?branch=dev)](https://coveralls.io/github/giannisdoukas/ipython2cwl?branch=dev)
 [![Documentation Status](https://readthedocs.org/projects/ipython2cwl/badge/?version=latest)](https://ipython2cwl.readthedocs.io/en/latest/?badge=latest)
+[![Downloads](https://pepy.tech/badge/ipython2cwl/month)](https://pepy.tech/project/ipython2cwl/month)
 
 IPython2CWL is a tool for converting [IPython](https://ipython.org/) Jupyter Notebooks to
-[CWL](https://www.commonwl.org/) Command Line Tools by simply providing typing annotation.
+[CWL (Common Workflow Language)](https://www.commonwl.org/) Command Line Tools by simply providing typing annotation.
 
 
 ```python
@@ -26,8 +27,15 @@ used by [mybinder](https://mybinder.org/). Now, by writing Jupyter Notebook and
 configuration, the community can not only execute the notebooks remotely but also to use them as steps in scientific
 workflows.
 
+
+## Install
+
+```
+pip install ipython2cwl
+```
+
 ### Example
 
-```shell script
+```
 jupyter repo2cwl https://github.com/giannisdoukas/cwl-annotated-jupyter-notebook.git -o cwlbuild
 ```

docs/index.rst

@@ -33,7 +33,7 @@ used by `mybinder <https://mybinder.org/>`_. Now, by writing Jupyter Notebook an
 configuration, the community can not only execute the notebooks remotely but also to use them as steps in scientific
 workflows.
 
-* Install ipython2cwl
+* Install ipython2cwl: :code:`pip install python2cwl`
 * Ensure that you have docker running
 * Create a directory to store the generated cwl files, for example cwlbuild
 * Execute :code:`jupyter repo2cwl https://github.com/giannisdoukas/cwl-annotated-jupyter-notebook.git -o cwlbuild`