Merge pull request #29 from alingse/release-2.1.0

try Release 2.1.0

Author: alingse

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E501

README.rst

@@ -1,6 +1,6 @@
 
-jsoncsv : convert json to csv or xlsx
-==========================================
+jsoncsv : easily convert json to csv or xlsx
+==============================================
 
 .. image:: https://img.shields.io/pypi/v/jsoncsv.svg
     :target: https://pypi.python.org/pypi/jsoncsv
@@ -25,6 +25,20 @@ cat the raw.json to csv/xls on command line
     cat raw.json |jsoncsv |mkexcel > output.csv
     cat raw.json |jsoncsv |mkexcel -t xls > output.xls
 
+or
+
+.. code-block:: bash
+
+    jsoncsv raw.json expand.json
+    mkexcel expand.json -t xls output.xls
+
+more options see --help.
+
+.. code-block:: bash
+
+    jsoncsv --help
+    mkexcel --help
+
 just expand/restore the json
 
 .. code-block:: bash
@@ -46,8 +60,6 @@ safe mod
 
     cat raw.json|jsoncsv --safe|mkexcel > output.csv
 
-    jsoncsv --help
-    mkexcel --help
 
 jsoncsv
 >>>>>>>>

jsoncsv/dumptool.py

@@ -162,13 +162,9 @@ def on_finish(self):
         self.wb.save(self.fout)
 
 
-def dump_excel(fin, fout, type_, **kwargs):
-    if type_ == 'csv':
-        DumpKlass = DumpCSV
-    elif type_ == 'xls':
-        DumpKlass = DumpXLS
-    else:
+def dump_excel(fin, fout, klass, **kwargs):
+    if not issubclass(klass, DumpExcel):
         raise ValueError("unknow dumpexcel type")
 
-    dump = DumpKlass(fin, fout, **kwargs)
+    dump = klass(fin, fout, **kwargs)
     dump.dump()

jsoncsv/jsontool.py

@@ -19,8 +19,6 @@
     'convert_json',
     'expand',
     'restore',
-    'gen_leaf',
-    'from_leaf',
 ]
 
 
@@ -135,12 +133,8 @@ def restore(expobj, separator='.', safe=False):
     return origin
 
 
-def convert_json(fin, fout, type="expand", separator=".", safe=False):
-    if type == "expand":
-        func = expand
-    elif type == "restore":
-        func = restore
-    else:
+def convert_json(fin, fout, func, separator=".", safe=False):
+    if func not in [expand, restore]:
         raise ValueError("unknow convert_json type")
 
     for line in fin:

jsoncsv/main.py

@@ -3,6 +3,8 @@
 import click
 import sys
 
+from jsoncsv import jsontool
+from jsoncsv import dumptool
 from jsoncsv.dumptool import dump_excel
 from jsoncsv.jsontool import convert_json
 from jsoncsv.utils import separator_type
@@ -44,11 +46,11 @@ def jsoncsv(output, input, expand, restore, safe, separator):
     if expand and restore:
         raise click.UsageError('can not choose both, default is `-e`')
 
-    type = "expand"  # default
+    func = jsontool.expand
     if restore:
-        type = "restore"
+        func = jsontool.restore
 
-    convert_json(input, output, type, separator, safe)
+    convert_json(input, output, func, separator, safe)
 
     input.close()
     output.close()
@@ -87,7 +89,11 @@ def mkexcel(output, input, sort_, row, type_):
     if output == sys.stdout and type_ == "xls":
         output = click.get_binary_stream('stdout')
 
-    dump_excel(input, output, type_, read_row=row, sort_type=sort_)
+    klass = dumptool.DumpCSV
+    if type_ == "xls":
+        klass = dumptool.DumpXLS
+
+    dump_excel(input, output, klass, read_row=row, sort_type=sort_)
 
     input.close()
     output.close()

jsoncsv/utils.py

@@ -2,15 +2,14 @@
 # author@alingse
 # 2016.11.20
 
+import click
 
 __all__ = []
 
 unit_char = '\\'
 
 
 def separator_type(sep):
-    import click
-
     if len(sep) > 1:
         raise click.BadOptionUsage('separator can only be a char')
     if sep == unit_char:
@@ -19,7 +18,7 @@ def separator_type(sep):
 
 
 def encode_safe_key(path, separator):
-    path = [p.replace(unit_char, unit_char*2) for p in path]
+    path = [p.replace(unit_char, unit_char * 2) for p in path]
     separator = unit_char + separator
     return separator.join(path)
 

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='jsoncsv',
-    version='2.1.0a',
+    version='2.1.0b',
     url='https://github.com/alingse/jsoncsv',
     description='A command tool easily convert json file to csv or xlsx.',
     long_description=readme,
@@ -38,5 +38,14 @@
             'jsoncsv = jsoncsv.main:jsoncsv',
             'mkexcel = jsoncsv.main:mkexcel',
         ],
-    }
+    },
+    keywords=[
+        'jsontocsv',
+        'jsoncsv',
+        'json',
+        'csv',
+        'xls'
+        'convert',
+        'command',
+    ],
 )

tests/test_jsontool.py

@@ -29,15 +29,15 @@ def test_list(self):
 
     def test_dict(self):
         s = {
-                "s": 1,
-                "w": 5,
-                "t": {
-                    "m": 0,
-                    "x": {
-                        "y": "z"
-                        }
-                    }
-            }
+            "s": 1,
+            "w": 5,
+            "t": {
+                "m": 0,
+                "x": {
+                    "y": "z"
+                },
+            },
+        }
 
         exp = expand(s)
         _s = restore(exp)
@@ -46,12 +46,12 @@ def test_dict(self):
 
     def test_complex(self):
         s = [
-                {"s": 0},
-                {"t": ["2", {"x": "z"}]},
-                0,
-                "w",
-                ["x", "g", 1]
-            ]
+            {"s": 0},
+            {"t": ["2", {"x": "z"}]},
+            0,
+            "w",
+            ["x", "g", 1]
+        ]
         exp = expand(s)
         _s = restore(exp)
 
@@ -100,7 +100,7 @@ def test_convert_expand(self):
         else:
             fout = io.BytesIO()
 
-        convert_json(fin, fout)
+        convert_json(fin, fout, expand)
 
         self.assertEqual('{"a.b": 3}\n{"a.c": 4}\n', fout.getvalue())
 
@@ -114,7 +114,7 @@ def test_convert_restore(self):
         else:
             fout = io.BytesIO()
 
-        convert_json(fin, fout, type="restore")
+        convert_json(fin, fout, restore)
 
         self.assertEqual('{"a": {"b": 3}}\n{"a": {"c": 4}}\n', fout.getvalue())
 

tests/test_mkexcel.py

@@ -4,6 +4,8 @@
 
 import unittest
 
+from jsoncsv.dumptool import DumpCSV
+from jsoncsv.dumptool import DumpXLS
 from jsoncsv.dumptool import dump_excel
 
 
@@ -14,7 +16,7 @@ def test_dumpexcel_csv(self):
         fin = open('./fixture/files/expand.1.json', 'r')
         fout = open('./fixture/files/tmp.output.1.csv', 'w')
 
-        dump_excel(fin, fout, 'csv')
+        dump_excel(fin, fout, DumpCSV)
         fin.close()
         fout.close()
 
@@ -30,7 +32,7 @@ def test_dumpexcel_csv_with_sort(self):
         fin = open('./fixture/files/expand.1.json', 'r')
         fout = open('./fixture/files/tmp.output.1.sort.csv', 'w')
 
-        dump_excel(fin, fout, 'csv', sort_type=True)
+        dump_excel(fin, fout, DumpCSV, sort_type=True)
         fin.close()
         fout.close()
 
@@ -46,7 +48,7 @@ def test_dumpcexcel_xls(self):
         fin = open('./fixture/files/expand.1.json', 'r')
         fout = open('./fixture/files/tmp.output.1.xls', 'wb')
 
-        dump_excel(fin, fout, 'xls')
+        dump_excel(fin, fout, DumpXLS)
 
         fin.close()
         fout.close()