Metadata-Version: 2.1
Name: termtables
Version: 0.2.2
Summary: Pretty tables in the terminal
Home-page: https://github.com/nschloe/termtables
Author: Nico Schlömer
License: GPL-3.0-or-later
Project-URL: Code, https://github.com/nschloe/termtables
Project-URL: Issues, https://github.com/nschloe/termtables/issues
Description: <p align="center">
          <a href="https://github.com/nschloe/termtables"><img alt="termtables" src="https://nschloe.github.io/termtables/termtables.svg" width="60%"></a>
          <p align="center">The tables have termed.</p>
        </p>
        
        [![gh-actions](https://img.shields.io/github/workflow/status/nschloe/termtables/ci?style=flat-square)](https://github.com/nschloe/termtables/actions?query=workflow%3Aci)
        [![codecov](https://img.shields.io/codecov/c/github/nschloe/termtables.svg?style=flat-square)](https://codecov.io/gh/nschloe/termtables)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
        [![awesome](https://img.shields.io/badge/awesome-yes-8209ba.svg?style=flat-square)](https://github.com/nschloe/termtables)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/termtables.svg?style=flat-square)](https://pypi.org/pypi/termtables/)
        [![PyPi Version](https://img.shields.io/pypi/v/termtables.svg?style=flat-square)](https://pypi.org/project/termtables)
        [![GitHub stars](https://img.shields.io/github/stars/nschloe/termtables.svg?logo=github&label=Stars&logoColor=white&style=flat-square)](https://github.com/nschloe/termtables)
        [![PyPi downloads](https://img.shields.io/pypi/dm/termtables.svg?style=flat-square)](https://pypistats.org/packages/termtables)
        
        
        termtables is a lightweight Python 3 package for pretty-printing tables on the command
        line. Install with
        ```
        pip install termtables
        ```
        The code
        ```python
        import termtables as tt
        import numpy
        
        numpy.random.seed(0)
        data = numpy.random.rand(5, 2)
        
        tt.print(data)
        # tt.to_string(data) returns the string
        ```
        produces
        
        ![table1](https://nschloe.github.io/termtables/table1.png)
        
        You can control border style, padding, alignment, and various other attributes. For
        example,
        ```python
        import termtables as tt
        
        header = ["a", "bb", "ccc"]
        data = [
            [1, 2, 3], [613.23236243236, 613.23236243236, 613.23236243236]
        ]
        
        tt.print(
            data,
            header=header,
            style=tt.styles.markdown,
            padding=(0, 1),
            alignment="lcr"
        )
        ```
        produces
        ```
        | a               |       bb        |             ccc |
        |-----------------|-----------------|-----------------|
        | 1               |        2        |               3 |
        | 613.23236243236 | 613.23236243236 | 613.23236243236 |
        ```
        which is useful for copy-pasting into websites that support Markdown (like GitHub).
        
        See
        [`test/test_termtables.py`](https://github.com/nschloe/termtables/blob/master/test/test_termtables.py)
        for more examples.
        
        If the styles in `termtables.styles`
        ```
        thin
        thin_thick
        thin_double
        rounded
        rounded_thick
        rounded_double
        thick
        thick_thin
        double
        double_thin
        booktabs
        
        ascii_thin
        ascii_thin_double
        ascii_double
        ascii_double_thin
        ascii_booktabs
        
        markdown
        ```
        aren't good enough for you, simply provide your own
        style as a string of length  11 or 15 (the extra 4 including header-separating
        characters). For example
        ```python
        import termtables as tt
        
        header = ["a", "bb", "ccc"]
        data = [
            [1, 2, 3], [613.23236243236, 613.23236243236, 613.23236243236]
        ]
        
        tt.print(
            data,
            header=header,
            style="x0123456789abcd"
        )
        ```
        produces
        ```
        1xxxxxxxxxxxxxxxxx7xxxxxxxxxxxxxxxxx7xxxxxxxxxxxxxxxxx2
        0 a               0 bb              0 ccc             0
        abbbbbbbbbbbbbbbbbcbbbbbbbbbbbbbbbbbcbbbbbbbbbbbbbbbbbd
        0 1               0 2               0 3               0
        5xxxxxxxxxxxxxxxxx9xxxxxxxxxxxxxxxxx9xxxxxxxxxxxxxxxxx6
        0 613.23236243236 0 613.23236243236 0 613.23236243236 0
        3xxxxxxxxxxxxxxxxx8xxxxxxxxxxxxxxxxx8xxxxxxxxxxxxxxxxx4
        ```
        
        
        ### Testing
        
        To run the termtables unit tests, check out this repository and type
        ```
        tox
        ```
        
        ### License
        This software is published under the [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.en.html).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Description-Content-Type: text/markdown
