Merge pull request #3 from giannisdoukas/dev

Dev

Author: giannisdoukas

MANIFEST.in

@@ -0,0 +1 @@
+include ipython2cwl/templates/*

README.md

@@ -4,3 +4,24 @@
 [![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)
 
+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.
+
+
+```python
+from ipython2cwl.iotypes import CWLFilePathInput, CWLFilePathOutput
+import csv
+input_filename: 'CWLFilePathInput' = 'data.csv'
+with open(input_filename) as f:
+  csv_reader = csv.reader(f)
+  data = [line for line in csv_reader]
+number_of_lines = len(data)
+result_file: 'CWLFilePathOutput' = 'number_of_lines.txt'
+with open(result_file, 'w') as f:
+  f.write(str(number_of_lines))
+```
+
+IPython2CWL is based on [repo2docker](https://github.com/jupyter/repo2docker), the same tool
+used by [mybinder](https://mybinder.org/). Now, by writing Jupyter Notebook and publish them, including repo2docker
+configuration, the community can not only execute the notebooks remotely but also to use them as steps in scientific
+workflows.

ipython2cwl/__init__.py

@@ -1 +1 @@
-__version__ = "0.1"
+__version__ = "0.0.1"

setup.py

@@ -29,7 +29,8 @@ def get_version(rel_path):
     version=get_version(f"{name}/__init__.py"),
     packages=['ipython2cwl'],
     package_dir={'ipython2cwl': 'ipython2cwl'},
-    package_data={'ipython2cwl': ['ipython2cwl/templates/*']},
+    package_data={'': ['ipython2cwl/templates/*']},
+    include_package_data=True,
     author='Yannis Doukas',
     author_email='[email protected]',
     description='Convert IPython Jupyter Notebooks to CWL tool',
@@ -63,4 +64,5 @@ def get_version(rel_path):
         'ipython>=7.15.0'
     ],
     test_suite='tests',
+    url='https://ipython2cwl.readthedocs.io/'
 )