Metadata-Version: 1.1
Name: pantable
Version: 0.1.1
Summary: CSV Tables in Markdown: Pandoc Filter for CSV Tables
Home-page: https://github.com/ickc/pantable
Author: Kolen Cheung
Author-email: christian.kolen@gmail.com
License: GPLv3
Description: .. raw:: html
        
           <!--This README is auto-generated from `docs/README.md`. Do not edit this file directly.-->
        
        -  `CSV Tables in Markdown: Pandoc Filter for CSV
           Tables <#csv-tables-in-markdown-pandoc-filter-for-csv-tables>`__
        -  `Example <#example>`__
        -  `Install and Use <#install-and-use>`__
        -  `Syntax <#syntax>`__
        -  `Related Filters <#related-filters>`__
        
        |Build Status| |GitHub Releases| |PyPI version| |Development Status|
        |Python version| |Downloads| |License| |Coveralls| |Scrutinizer|
        
        CSV Tables in Markdown: Pandoc Filter for CSV Tables
        ====================================================
        
        This allows CSV tables, optionally containing markdown syntax (enabled
        by default), to be put in markdown as a fenced code blocks.
        
        Example
        =======
        
        This won’t work on GitHub’s markdown rendering nor PyPI. See the README
        in `GitHub-pages <https://ickc.github.io/pantable/>`__. There’s a `LaTeX
        output <https://ickc.github.io/pantable/README.pdf>`__ too.
        
        ::
        
            ```table
            ---
            caption: '*Awesome* **Markdown** Table'
            alignment: RC
            table-width: 0.7
            markdown: True
            ---
            First row,defaulted to be header row,can be disabled
            1,cell can contain **markdown**,"It can be aribrary block element:
        
            - following standard markdown syntax
            - like this"
            2,"Any markdown syntax, e.g.",$$E = mc^2$$
            ```
        
        becomes
        
        .. raw:: html
        
           <table style="width:70%;">
        
        .. raw:: html
        
           <caption>
        
        Awesome Markdown Table
        
        .. raw:: html
        
           </caption>
        
        .. raw:: html
        
           <colgroup>
        
        .. raw:: html
        
           <col width="8%" />
        
        .. raw:: html
        
           <col width="27%" />
        
        .. raw:: html
        
           <col width="34%" />
        
        .. raw:: html
        
           </colgroup>
        
        .. raw:: html
        
           <thead>
        
        .. raw:: html
        
           <tr class="header">
        
        .. raw:: html
        
           <th align="right">
        
        .. raw:: html
        
           <p>
        
        First row
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th align="center">
        
        .. raw:: html
        
           <p>
        
        defaulted to be header row
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th>
        
        .. raw:: html
        
           <p>
        
        can be disabled
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           </thead>
        
        .. raw:: html
        
           <tbody>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td align="right">
        
        .. raw:: html
        
           <p>
        
        1
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td align="center">
        
        .. raw:: html
        
           <p>
        
        cell can contain markdown
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           <p>
        
        It can be aribrary block element:
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           <ul>
        
        .. raw:: html
        
           <li>
        
        following standard markdown syntax
        
        .. raw:: html
        
           </li>
        
        .. raw:: html
        
           <li>
        
        like this
        
        .. raw:: html
        
           </li>
        
        .. raw:: html
        
           </ul>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td align="right">
        
        .. raw:: html
        
           <p>
        
        2
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td align="center">
        
        .. raw:: html
        
           <p>
        
        Any markdown syntax, e.g.
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           <p>
        
        E = mc2
        
        .. raw:: html
        
           </p>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           </tbody>
        
        .. raw:: html
        
           </table>
        
        Install and Use
        ===============
        
        Install:
        
        .. code:: bash
        
            pip install -U pantable
        
        Use:
        
        .. code:: bash
        
            pandoc -F pantable -o README.html README.md
        
        Syntax
        ======
        
        Fenced code blocks is used, with a class ``table``. See
        `Example <#example>`__.
        
        Optionally, YAML metadata block can be used within the fenced code
        block, following standard pandoc YAML metadata block syntax. 7 metadata
        keys are recognized:
        
        -  ``caption``: the caption of the table. If omitted, no caption will be
           inserted. Default: disabled.
        
        -  ``alignment``: a string of characters among ``L,R,C,D``,
           case-insensitive, corresponds to Left-aligned, Right-aligned,
           Center-aligned, Default-aligned respectively. e.g. ``LCRD`` for a
           table with 4 columns. Default: ``DDD...``
        
        -  ``width``: a list of relative width corresponding to the width of
           each columns. e.g.
        
           .. code:: yaml
        
               - width
                   - 0.1
                   - 0.2
                   - 0.3
                   - 0.4
        
           Default: auto calculated from the length of each line in table cells.
        
        -  ``table-width``: the relative width of the table (e.g. relative to
           ``\linewidth``). default: 1.0
        
        -  ``header``: If it has a header row or not. True/False/yes/NO are
           accepted, case-insensitive. default: True
        
        -  ``markdown``: If CSV table cell contains markdown syntax or not. Same
           as above. Default: False
        
        -  ``include``: the path to an CSV file, can be relative/absolute. If
           non-empty, override the CSV in the CodeBlock. default: None
        
        When the metadata keys is invalid, the default will be used instead.
        
        Related Filters
        ===============
        
        The followings are pandoc filters written in Haskell that provide
        similar functionality. This filter is born after testing with theirs.
        
        -  `baig/pandoc-csv2table: A Pandoc filter that renders CSV as Pandoc
           Markdown Tables. <https://github.com/baig/pandoc-csv2table>`__
        -  `mb21/pandoc-placetable: Pandoc filter to include CSV data (from file
           or URL) <https://github.com/mb21/pandoc-placetable>`__
        -  `sergiocorreia/panflute/csv-tables.py <https://github.com/sergiocorreia/panflute/blob/1ddcaba019b26f41f8c4f6f66a8c6540a9c5f31a/docs/source/csv-tables.py>`__
        
        .. raw:: html
        
           <table>
        
        .. raw:: html
        
           <colgroup>
        
        .. raw:: html
        
           <col width="7%" />
        
        .. raw:: html
        
           <col width="26%" />
        
        .. raw:: html
        
           <col width="15%" />
        
        .. raw:: html
        
           <col width="13%" />
        
        .. raw:: html
        
           <col width="36%" />
        
        .. raw:: html
        
           </colgroup>
        
        .. raw:: html
        
           <thead>
        
        .. raw:: html
        
           <tr class="header">
        
        .. raw:: html
        
           <th>
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th>
        
        pandoc-csv2table
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th>
        
        pandoc-placetable
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th>
        
        panflute example
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           <th>
        
        pantable
        
        .. raw:: html
        
           </th>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           </thead>
        
        .. raw:: html
        
           <tbody>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        caption
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        caption
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        caption
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        title
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        caption
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        aligns
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        aligns = LRCD
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        aligns = LRCD
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        aligns = LRCD
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        width
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        widths = "0.5 0.2 0.3"
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        width: [0.5, 0.2, 0.3]
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        table-width
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        table-width: 1.0
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        header
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        header = yes \| no
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        header = yes \| no
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        header: True \| False
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        header: True \| False \| yes \| NO
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        markdown
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        inlinemarkdown
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        markdown: True \| False \| yes \| NO
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        source
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        source
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        file
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        source
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        include
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        others
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        type = simple \| multiline \| grid \| pipe
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        delimiter
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        quotechar
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="odd">
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        id (wrapped by div)
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           <tr class="even">
        
        .. raw:: html
        
           <td>
        
        Notes
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           <td>
        
        width are auto-calculated when width is not specified
        
        .. raw:: html
        
           </td>
        
        .. raw:: html
        
           </tr>
        
        .. raw:: html
        
           </tbody>
        
        .. raw:: html
        
           </table>
        
        .. |Build Status| image:: https://travis-ci.org/ickc/pantable.svg?branch=master
           :target: https://travis-ci.org/ickc/pantable
        .. |GitHub Releases| image:: https://img.shields.io/github/tag/ickc/pantable.svg?label=github+release
           :target: https://github.com/ickc/pantable/releases
        .. |PyPI version| image:: https://img.shields.io/pypi/v/pantable.svg
           :target: https://pypi.python.org/pypi/pantable/
        .. |Development Status| image:: https://img.shields.io/pypi/status/pantable.svg
           :target: https://pypi.python.org/pypi/pantable/
        .. |Python version| image:: https://img.shields.io/pypi/pyversions/pantable.svg
           :target: https://pypi.python.org/pypi/pantable/
        .. |Downloads| image:: https://img.shields.io/pypi/dm/pantable.svg
           :target: https://pypi.python.org/pypi/pantable/
        .. |License| image:: https://img.shields.io/pypi/l/pantable.svg
        .. |Coveralls| image:: https://img.shields.io/coveralls/ickc/pantable.svg
           :target: https://coveralls.io/github/ickc/pantable
        .. |Scrutinizer| image:: https://img.shields.io/scrutinizer/g/ickc/pantable.svg
           :target: https://scrutinizer-ci.com/g/ickc/pantable/
        
Keywords: pandoc pandocfilters panflute markdown latex
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Text Processing :: Filters
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
