Metadata-Version: 2.1
Name: mpl-table
Version: 0.1.6
Summary: Create custom table using matplotlib.
Home-page: https://github.com/geo7/mpl_table
License: MIT
Keywords: matplotlib,table,custom,heatmap
Author: George Lenton
Author-email: georgelenton@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: matplotlib (>=3.4.3,<4.0.0)
Requires-Dist: pandas (>=1.3.4,<2.0.0)
Description-Content-Type: text/markdown

# MPL Table

Create a table with row explanations, column headers, using matplotlib. Intended usage
was a small table containing a custom heatmap.

## Installation

`pip install mpl-table`

## Usage

Example usage can be found within `tests/test_create_table.py`, the table is created by
passing dataframes containing text values, cell colour values, and text colour values.
You'll probably want to use `bbox_inches="tight"` when you `fig.savefig`.

## Example output

Table with row headers:

![Example output table.](./tests/baseline/test_table_image.png)

Table in subplots:

![Example output in subplots.](./tests/baseline/test_subplots_1.png)

Table with no row headers:

![Example output table without row headers.](./tests/baseline/test_table_with_no_row_headers.png)

Table with no row or column headers:

![Example output table without row or column headers.](./tests/baseline/test_table_with_no_row_headers_and_no_column_headers.png)

## Why

Wanted to be able to create tables containing heatmaps, along with row explanations and
different treatment of high/low values for each row. For some rows the formatting of
`100%` should be considered positive (typically green), whereas others it should be
considered negative (typically
red).

## TODO

Simplify creating a table without any row-headers.

Consider makign the spacing for rows/cols dynamic, based on figsize might work.

Usage within subplots, wasn't required for what was needed, but there could be some use
in having subplots with these tables.

Different styles - might want to have the header row / row information column without any
background colour, or similar stylings. Shouldn't be hard to do from what's here, just
hasn't been done.

