Metadata-Version: 1.1
Name: pytablewriter
Version: 0.10.1
Summary: pytablewriter is a python library to write a table in various formats: CSV/HTML/JavaScript/JSON/Markdown/MediaWiki/Excel/Pandas/Python/reStructuredText

Home-page: https://github.com/thombashi/pytablewriter
Author: Tsuyoshi Hombashi
Author-email: gogogo.vm@gmail.com
License: MIT License
Description: pytablewriter
        =============
        
        .. image:: https://img.shields.io/pypi/pyversions/pytablewriter.svg
           :target: https://pypi.python.org/pypi/pytablewriter
        .. image:: https://travis-ci.org/thombashi/pytablewriter.svg?branch=master
            :target: https://travis-ci.org/thombashi/pytablewriter
        .. image:: https://ci.appveyor.com/api/projects/status/2w0611ajvw21vho5?svg=true
            :target: https://ci.appveyor.com/project/thombashi/pytablewriter
        .. image:: https://coveralls.io/repos/github/thombashi/pytablewriter/badge.svg?branch=master
            :target: https://coveralls.io/github/thombashi/pytablewriter?branch=master
        
        Summary
        -------
        
        pytablewriter is a python library to write a table in various formats: CSV/HTML/JavaScript/JSON/Markdown/MediaWiki/Excel/Pandas/Python/reStructuredText
        
        Features
        --------
        
        - Write a table in various formats:
            - CSV
            - Microsoft Excel :superscript:`TM`
                - `.xlsx` format
                - `.xls` format
            - HTML
            - JavaScript (Definition of a nested list variable)
            - JSON
            - Markdown
            - MediaWiki
            - Pandas (Definition of a DataFrame variable)
            - Python code (Definition of a nested list variable)
            - reStructuredText
                - Grid tables
                - Simple tables
                - CSV table
        - Automatic value formatting
            - Alignment
            - Padding
            - Decimal places of numbers
        - Output to a stream such as a file or the standard output
        
        Examples
        ========
        
        Write a Markdown table
        ----------------------
        
        .. code:: python
        
            import pytablewriter
        
            writer = pytablewriter.MarkdownTableWriter()
            writer.table_name = "example_table"
            writer.header_list = ["int", "float", "str", "bool", "mix", "time"]
            writer.value_matrix = [
                [0,   0.1,      "hoge", True,   0,      "2017-01-01 03:04:05+0900"],
                [2,   "-2.23",  "foo",  False,  None,   "2017-12-23 45:01:23+0900"],
                [3,   0,        "bar",  "true",  "inf", "2017-03-03 33:44:55+0900"],
                [-10, -9.9,     "",     "FALSE", "nan", "2017-01-01 00:00:00+0900"],
            ]
        
            writer.write_table()
        
        .. code::
        
            # example_table
            int|float|str |bool |mix|          time
            --:|----:|----|-----|--:|------------------------
              0|  0.1|hoge|True |  0|2017-01-01 03:04:05+0900
              2| -2.2|foo |False|   |2017-12-23 12:34:51+0900
              3|  0.0|bar |True |inf|2017-03-03 22:44:55+0900
            -10| -9.9|    |False|nan|2017-01-01 00:00:00+0900
        
        
        Rendering result
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. figure:: ss/markdown.png
           :scale: 80%
           :alt: markdown_ss
        
           Rendered markdown at GitHub
        
        Write a reStructuredText table (grid tables)
        --------------------------------------------
        
        
        .. code:: python
        
            import pytablewriter
        
            writer = pytablewriter.RstGridTableWriter()
            writer.table_name = "example_table"
            writer.header_list = ["int", "float", "str", "bool", "mix", "time"]
            writer.value_matrix = [
                [0,   0.1,      "hoge", True,   0,      "2017-01-01 03:04:05+0900"],
                [2,   "-2.23",  "foo",  False,  None,   "2017-12-23 45:01:23+0900"],
                [3,   0,        "bar",  "true",  "inf", "2017-03-03 33:44:55+0900"],
                [-10, -9.9,     "",     "FALSE", "nan", "2017-01-01 00:00:00+0900"],
            ]
        
            writer.write_table()
        
        
        .. code::
        
            .. table:: example_table
        
                +---+-----+----+-----+---+------------------------+
                |int|float|str |bool |mix|          time          |
                +===+=====+====+=====+===+========================+
                |  0|  0.1|hoge|True |  0|2017-01-01 03:04:05+0900|
                +---+-----+----+-----+---+------------------------+
                |  2| -2.2|foo |False|   |2017-12-23 12:34:51+0900|
                +---+-----+----+-----+---+------------------------+
                |  3|  0.0|bar |True |inf|2017-03-03 22:44:55+0900|
                +---+-----+----+-----+---+------------------------+
                |-10| -9.9|    |False|nan|2017-01-01 00:00:00+0900|
                +---+-----+----+-----+---+------------------------+
        
        Rendering result
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. table:: example_table
        
            +---+-----+----+-----+---+------------------------+
            |int|float|str |bool |mix|          time          |
            +===+=====+====+=====+===+========================+
            |  0|  0.1|hoge|True |  0|2017-01-01 03:04:05+0900|
            +---+-----+----+-----+---+------------------------+
            |  2| -2.2|foo |False|   |2017-12-23 12:34:51+0900|
            +---+-----+----+-----+---+------------------------+
            |  3|  0.0|bar |True |inf|2017-03-03 22:44:55+0900|
            +---+-----+----+-----+---+------------------------+
            |-10| -9.9|    |False|nan|2017-01-01 00:00:00+0900|
            +---+-----+----+-----+---+------------------------+
        
        Write a JavaScript table (variable definition of nested list)
        -------------------------------------------------------------
        
        .. code:: python
        
            import pytablewriter
        
            writer = pytablewriter.JavaScriptTableWriter()
            writer.table_name = "example_table"
            writer.header_list = ["int", "float", "str", "bool", "mix", "time"]
            writer.value_matrix = [
                [0,   0.1,      "hoge", True,   0,      "2017-01-01 03:04:05+0900"],
                [2,   "-2.23",  "foo",  False,  None,   "2017-12-23 45:01:23+0900"],
                [3,   0,        "bar",  "true",  "inf", "2017-03-03 33:44:55+0900"],
                [-10, -9.9,     "",     "FALSE", "nan", "2017-01-01 00:00:00+0900"],
            ]
        
            writer.write_table()
        
        .. code:: js
        
            var example_table = [
                ["int", "float", "str", "bool", "mix", "time"],
                [0, 0.1, "hoge", true, 0, new Date("2017-01-01T03:04:05+0900")],
                [2, -2.2, "foo", false, null, new Date("2017-12-23T12:34:51+0900")],
                [3, 0.0, "bar", true, Infinity, new Date("2017-03-03T22:44:55+0900")],
                [-10, -9.9, "", false, NaN, new Date("2017-01-01T00:00:00+0900")]
            ];
        
        Write an Excel table
        --------------------
        
        .. code:: python
        
            import pytablewriter
        
            writer = pytablewriter.ExcelXlsxTableWriter()
            writer.open_workbook("sample.xlsx")
        
            writer.make_worksheet("example")
            writer.header_list = ["int", "float", "str", "bool", "mix", "time"]
            writer.value_matrix = [
                [0,   0.1,      "hoge", True,   0,      "2017-01-01 03:04:05+0900"],
                [2,   "-2.23",  "foo",  False,  None,   "2017-12-23 12:34:51+0900"],
                [3,   0,        "bar",  "true",  "inf", "2017-03-03 22:44:55+0900"],
                [-10, -9.9,     "",     "FALSE", "nan", "2017-01-01 00:00:00+0900"],
            ]
            writer.write_table()
        
            writer.close()
        
        
        Output of Excel book
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. figure:: ss/excel_single.png
           :scale: 100%
           :alt: excel_single
        
           Output excel file (``sample_single.xlsx``)
        
        For more information
        --------------------
        
        More examples are available at 
        http://pytablewriter.readthedocs.org/en/latest/pages/examples/index.html
        
        Installation
        ============
        
        ::
        
            pip install pytablewriter
        
        
        Dependencies
        ============
        
        Python 2.7+ or 3.3+
        
        - `DataPropery <https://github.com/thombashi/DataProperty>`__
        - `dominate <http://github.com/Knio/dominate/>`__
        - `pathvalidate <https://github.com/thombashi/pathvalidate>`__
        - `six <https://pypi.python.org/pypi/six/>`__
        - `XlsxWriter <http://xlsxwriter.readthedocs.io/>`__
        - `xlwt <http://www.python-excel.org/>`__
        
        
        Test dependencies
        -----------------
        
        - `pytest <http://pytest.org/latest/>`__
        - `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
        - `SimpleSQLite <https://github.com/thombashi/SimpleSQLite>`__
        - `tox <https://testrun.org/tox/latest/>`__
        
        Documentation
        =============
        
        http://pytablewriter.readthedocs.org/en/latest/
        
        
Keywords: table,CSV,Excel,JavaScript,JSON,Markdown,MediaWiki,HTML,Pandas,reStructuredText
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
