Metadata-Version: 2.1
Name: statworx-theme
Version: 0.2.1
Summary: A color theme for matplotlib using the offical statworx design
Author: An Hoang
Author-email: an.hoang@statworx.com
Requires-Python: >=3.8.9,<3.9.0
Classifier: Programming Language :: Python :: 3
Requires-Dist: seaborn (>=0.11.2,<0.12.0)
Description-Content-Type: text/markdown

# Statworx Theme

A color theme plugin for the [matplotlib](https://matplotlib.org/) library and all its derivatives, which automatically applies the official statworx color theme.
This package also registers commonly used [color maps](https://matplotlib.org/stable/tutorials/colors/colormaps.html) for use in presentations.

<center>
    <img src="./docs/assets/sample.png" width="400" />
</center>

## Quick Start

Simply install a module with `pip` by using the following command.

```console
pip install statworx-theme
```

To apply the style, you must call the `apply_style` function by typing:

```python
from statworx_theme import apply_style
apply_style()
```

## Gallery

<!-- TODO: Add link -->
We have an extensive gallery of figures using the statworx theme. You can see them [here](abc).

