summaryrefslogtreecommitdiff
path: root/Tools/XlsToCsv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Tools/XlsToCsv/README.md')
-rw-r--r--Tools/XlsToCsv/README.md119
1 files changed, 119 insertions, 0 deletions
diff --git a/Tools/XlsToCsv/README.md b/Tools/XlsToCsv/README.md
new file mode 100644
index 0000000..e7bd612
--- /dev/null
+++ b/Tools/XlsToCsv/README.md
@@ -0,0 +1,119 @@
+
+# xlsx2csv
+
+> xlsx to csv converter (http://github.com/dilshod/xlsx2csv)
+
+Converts xlsx files to csv format.
+Handles large XLSX files. Fast and easy to use.
+
+## Supported python versions:
+ - 2.4
+ - 2.7
+ - 3.4
+
+## Installation:
+
+```sh
+sudo easy_install xlsx2csv
+```
+ or
+
+```sh
+pip install xlsx2csv
+```
+
+
+ Also, works standalone with only the *xlsx2csv.py* script
+
+**Usage:**
+```
+ xlsx2csv.py [-h] [-v] [-a] [-c OUTPUTENCODING] [-s SHEETID]
+ [-n SHEETNAME] [-d DELIMITER] [-l LINETERMINATOR]
+ [-f DATEFORMAT] [--floatformat FLOATFORMAT]
+ [-i] [-e] [-p SHEETDELIMITER]
+ [--hyperlinks]
+ [-I INCLUDE_SHEET_PATTERN [INCLUDE_SHEET_PATTERN ...]]
+ [-E EXCLUDE_SHEET_PATTERN [EXCLUDE_SHEET_PATTERN ...]] [-m]
+ xlsxfile [outfile]
+```
+**positional arguments:**
+```
+ xlsxfile xlsx file path
+ outfile output csv file path, or directory if -s 0 is specified
+```
+**optional arguments:**
+```
+ -h, --help show this help message and exit
+ -v, --version show program's version number and exit
+ -a, --all export all sheets
+ -c OUTPUTENCODING, --outputencoding OUTPUTENCODING
+ encoding of output csv ** Python 3 only ** (default: utf-8)
+ -s SHEETID, --sheet SHEETID
+ sheet number to convert, 0 for all
+ -n SHEETNAME, --sheetname SHEETNAME
+ sheet name to convert
+ -d DELIMITER, --delimiter DELIMITER
+ delimiter - columns delimiter in csv, 'tab' or 'x09'
+ for a tab (default: comma ',')
+ -l LINETERMINATOR, --lineterminator LINETERMINATOR
+ line terminator - lines terminator in csv, '\n' '\r\n'
+ or '\r' (default: os.linesep)
+ -f DATEFORMAT, --dateformat DATEFORMAT
+ override date/time format (ex. %Y/%m/%d)
+ --floatformat FLOATFORMAT
+ override float format (ex. %.15f)
+ -i, --ignoreempty skip empty lines
+ -e, --escape Escape \r\n\t characters
+ -p SHEETDELIMITER, --sheetdelimiter SHEETDELIMITER
+ sheet delimiter used to separate sheets, pass '' if
+ you do not need delimiter, or 'x07' or '\\f' for form
+ feed (default: '--------')
+ -q QUOTING, --quoting QUOTING
+ field quoting, 'none' 'minimal' 'nonnumeric' or 'all' (default: 'minimal')
+ --hyperlinks, --hyperlinks
+ include hyperlinks
+ -I INCLUDE_SHEET_PATTERN [INCLUDE_SHEET_PATTERN ...], --include_sheet_pattern INCLUDE_SHEET_PATTERN [INCLUDE_SHEET_PATTERN ...]
+ only include sheets named matching given pattern, only
+ effects when -a option is enabled.
+ -E EXCLUDE_SHEET_PATTERN [EXCLUDE_SHEET_PATTERN ...], --exclude_sheet_pattern EXCLUDE_SHEET_PATTERN [EXCLUDE_SHEET_PATTERN ...]
+ exclude sheets named matching given pattern, only
+ effects when -a option is enabled.
+ -m, --merge-cells merge cells
+```
+
+Usage from within Python:
+```
+ from xlsx2csv import Xlsx2csv
+ Xlsx2csv("myfile.xlsx", outputencoding="utf-8").convert("myfile.csv")
+```
+
+Expat SAX parser used for xml parsing.
+
+See alternatives:
+
+Bash:
+http://kirk.webfinish.com/?p=91
+
+Python:
+http://github.com/staale/python-xlsx
+http://github.com/leegao/pyXLSX
+
+Ruby:
+http://roo.rubyforge.org/
+
+Java:
+http://poi.apache.org/
+
+
+All programs in this directory and subdirectories are published under
+license GNU GPL version 2 or (at your option) any later version. For
+more information, see COPYING or visit <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>.
+
+
+## Meta
+
+ Dilshod Temirkhdojaev – tdilshod@gmail.com
+
+Distributed under the GNU GENERAL PUBLIC LICENSE. See ``LICENSE`` for more information.
+
+[https://github.com/dilshod](https://github.com/dilshod)