unify the read and write interface among pyexcel plugins

Author: chfw

README.rst

@@ -37,12 +37,12 @@ Installation
 
 You can install it via pip::
 
-    $ pip install git+https://github.com/chfw/ezodf.git
+    $ pip install git+https://github.com/T0ha/ezodf.git
     $ pip install pyexcel-ods3
 
 or clone it and install it::
 
-    $ pip install git+https://github.com/chfw/ezodf.git
+    $ pip install git+https://github.com/T0ha/ezodf.git
     $ pip install git+https://github.com/chfw/pyexcel-ods3.git
     $ cd pyexcel-ods3
     $ python setup.py install
@@ -64,50 +64,43 @@ As a standalone library
     ...     from StringIO import StringIO
     ... else:
     ...     from io import BytesIO as StringIO
-    >>> from pyexcel_xls import OrderedDict
+    >>> from pyexcel_io import OrderedDict
 
 
 Write to an ods file
 *********************
 
 Here's the sample code to write a dictionary to an ods file::
 
-    >>> from pyexcel_ods3 import ODSWriter
+    >>> from pyexcel_ods3 import store_data
     >>> data = OrderedDict()
     >>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
     >>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
-    >>> writer = ODSWriter("your_file.ods")
-    >>> writer.write(data)
-    >>> writer.close()
+    >>> store_data("your_file.ods", data)
 
 Read from an ods file
 **********************
 
 Here's the sample code::
 
-    >>> from pyexcel_ods3 import ODSBook
-    >>> book = ODSBook("your_file.ods")
-    >>> # book.sheets() returns a dictionary of all sheet content
-    >>> #   the keys represents sheet names
-    >>> #   the values are two dimensional array
+    >>> from pyexcel_ods3 import load_data
+    >>> data = load_data("your_file.ods")
     >>> import json
-    >>> print(json.dumps(book.sheets()))
+    >>> print(json.dumps(data))
     {"Sheet 1": [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], "Sheet 2": [["row 1", "row 2", "row 3"]]}
 
 Write an ods file to memory
-*****************************
+******************************
 
 Here's the sample code to write a dictionary to an ods file::
 
-    >>> from pyexcel_ods3 import ODSWriter
+    >>> from pyexcel_ods3 import store_data
     >>> data = OrderedDict()
     >>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
     >>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]})
     >>> io = StringIO()
-    >>> writer = ODSWriter(io)
-    >>> writer.write(data)
-    >>> writer.close()
-    >>> # do something witht the io
+    >>> store_data(io, data)
+    >>> # do something with the io
     >>> # In reality, you might give it to your http response
     >>> # object for downloading
 
@@ -118,10 +111,11 @@ Read from an ods from memory
 Here's the sample code::
 
     >>> # This is just an illustration
-    >>> # In reality, you might deal with xl file upload
-    >>> # where you will read from requests.FILES['YOUR_XL_FILE']
-    >>> book = ODSBook(None, io.getvalue())
-    >>> print(json.dumps(book.sheets()))
+    >>> # In reality, you might deal with ods file upload
+    >>> # where you will read from requests.FILES['YOUR_ODS_FILE']
+	>>> io.seek(0)
+    >>> data = load_data(io)
+    >>> print(json.dumps(data))
     {"Sheet 1": [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], "Sheet 2": [[7.0, 8.0, 9.0], [10.0, 11.0, 12.0]]}
 
 
@@ -161,19 +155,19 @@ Here is the sample code::
 
     >>> sheet.save_as("another_file.ods")
 
-Reading from a StringIO instance
+Reading from a IO instance
 ================================
 
 You got to wrap the binary content with StringIO to get odf working::
 
 
     >>> # This is just an illustration
     >>> # In reality, you might deal with xl file upload
-    >>> # where you will read from requests.FILES['YOUR_XL_FILE']
-    >>> xlfile = "another_file.ods"
-    >>> with open(xlfile, "rb") as f:
+    >>> # where you will read from requests.FILES['YOUR_ODS_FILE']
+    >>> odsfile = "another_file.ods"
+    >>> with open(odsfile, "rb") as f:
     ...     content = f.read()
-    ...     r = pe.get_book(file_type="ods", content=content)
+    ...     r = pe.get_book(file_type="ods", file_content=content)
     ...     print(r)
     ...
     Sheet Name: Sheet 1

pyexcel_ods3/__init__.py

@@ -16,12 +16,13 @@
     SheetWriter,
     BookWriter,
     READERS,
-    WRITERS
+    WRITERS,
+    isstream,
+    load_data as read_data,
+    store_data as write_data
 )
-if sys.version_info[0] < 3:
-    from StringIO import StringIO
-else:
-    from io import BytesIO as StringIO
+import sys
+PY2 = sys.version_info[0] == 2
 
 
 def float_value(value):
@@ -136,7 +137,7 @@ def load_from_file(self, filename, **keywords):
         return ezodf.opendoc(filename)
 
     def load_from_memory(self, file_content, **keywords):
-        return ezodf.opendoc(StringIO(file_content))
+        return ezodf.opendoc(file_content)
 
     def sheet_iterator(self):
         if self.sheet_name is not None:
@@ -227,4 +228,29 @@ def close(self):
 WRITERS["ods"] = ODSWriter
 
 
+
+def is_string(atype):
+    """find out if a type is str or not"""
+    if atype == str:
+            return True
+    elif PY2:
+        if atype == unicode:
+            return True
+        elif atype == str:
+            return True
+    return False
+
+
+def store_data(afile, data, file_type=None, **keywords):
+    if isstream(afile) and file_type is None:
+        file_type='ods'
+    write_data(afile, data, file_type=file_type, **keywords)
+
+
+def load_data(afile, file_type=None, **keywords):
+    if isstream(afile) and file_type is None:
+        file_type='ods'
+    return read_data(afile, file_type=file_type, **keywords)
+
+
 __VERSION__ = "0.0.8"