Metadata-Version: 1.1
Name: dashtable
Version: 1.2.7
Summary: A library for converting a HTML tables into ASCII tables
Home-page: https://github.com/doakey3/DashTable
Author: doakey3
Author-email: dashtable.dmodo@spamgourmet.com
License: MIT
Download-URL: https://github.com/doakey3/DashTable/tarball/1.2.7
Description: .. contents::
        
        Video Tutorial
        ==============
        
        .. image:: http://i.imgur.com/v1rGCHn.png
            :target: https://www.youtube.com/watch?v=bdcswQq4lIM&feature=youtu.be
        
        Introduction
        ============
        
        Use DashTable to create ASCII tables like this reStructured_ Table:
        
        .. _reStructured: http://docutils.sourceforge.net/rst.html
        
        ::
        
            +------------+------------+-----------+
            | Header 1   | Header 2   | Header 3  |
            +============+============+===========+
            | body row 1 | column 2   | column 3  |
            +------------+------------+-----------+
            | body row 2 | Cells may span columns.|
            +------------+------------+-----------+
            | body row 3 | Cells may  | - Cells   |
            +------------+ span rows. | - contain |
            | body row 4 |            | - blocks. |
            +------------+------------+-----------+
        
        Installation
        ============
        
        ::
        
            pip install dashtable
        
        Example Usage
        =============
        
        HTML to reStructured Table
        --------------------------
        
        html2rst requires a filepath or a string to work.
        
        .. code-block:: python
        
            from dashtable import html2rst
        
            filepath = "path/to/html/file.html"
            print(html2rst(filepath, force_headers=False))
        
        
        Command Line Method:
        
        ::
        
            python html2rst.py input.html output.rst --force_headers
        
        HTML to MarkDown Table
        ----------------------
        
        html2md requires a filepath or a string to work.
        
        .. code-block:: python
        
            from dashtable import html2md
        
            filepath = "path/to/html/file.html"
            print(html2md(filepath))
        
        Command line method:
        
        ::
        
            python html2md.py input.html output.md
        
        List of Lists to reStructered Table
        -----------------------------------
        
        .. code-block:: python
        
            from dashtable import data2rst
        
            table = [
                ['Row\nSpan', 'Header'],
                ['Cell', ''],
                ['Column Span', '']
                ]
        
            column_span = ([0, 0], [1, 0])
            row_span = ([2, 0], [2, 1])
        
            spans = [column_span, row_span]
        
            print(data2rst(table, spans, use_headers=True))
        
        List of Lists to Markdown Table
        -------------------------------
        
        .. code-block:: python
        
            from dashtable import data2md
        
            table = [
                ['Header 1', 'Header 2', 'Header 3'],
                ['Column 1', 'Column 2', 'Column 3']
            ]
        
            print(data2md(table))
            
        
        
Platform: UNKNOWN
