statworx_theme 2.0.3

DEPRECATED - no longer maintained. A color theme for matplotlib using the offical statworx design

Statworx Theme

[!WARNING] This package is deprecated and is no longer being developed or maintained.

statworx-theme will receive no further updates, bug fixes, or support, and no new releases are planned. The package remains available on PyPI for existing users, but we recommend migrating away from it. Feel free to fork the repository if you wish to continue development independently.

A color theme plugin for the matplotlib library and all its derivatives, as well as an optional adaption of this theme for altair and plotly, which automatically applies the official statworx color theme. This package also registers commonly used qualitative color maps (such as a fade from good to bad) for use in presentations.

Quick Start

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

pip install statworx-theme

For usage of altair and plotly extra dependencies need to be installed using pip.

pip install "statworx-theme[altair]"
pip install "statworx-theme[plotly]"

For using the styles inside a poetry managed project use poetry add with extras.

#only matplotlib
poetry add statworx-theme

# altair theme
poetry add statworx-theme -E "altair"

# plotly theme
poetry add statworx-theme -E "plotly"

# Whole package
poetry add statworx-theme -E "altair plotly"

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

from statworx_theme import apply_style
apply_style()

For applying the plotly or altair style the respective apply_style_<library> function is used:

from statworx_theme import apply_style_altair, apply_style_plotly
apply_style_altair()
apply_style_plotly()

Gallery

Matplotlib

There is an extensive gallery of figures that use the Statworx theme that you can draw inspiration from. You can find it here. For a figure gallery using the altair and plotly theme see the respective notebooks inside the repository.

Custom Colors

You can also use a custom list of color for the color scheme beside the official statworx colors. There is a convenience function for that which is described below. This simply changes the colors.

Matplotlib

In case you want to change the entire style you should implement your own .mplstyle file (see this).

from statworx_theme import apply_custom_colors

custom_colors = [
    DARK_BLUE := "#0A526B",
    DARK_RED := "#6B0020",
    GREY := "#808285",
]
apply_custom_colors(custom_colors)

Altair

from statworx_theme import apply_custom_colors_altair

custom_colors = [
    DARK_BLUE := "#0A526B",
    DARK_RED := "#6B0020",
    GREY := "#808285",
]
apply_custom_colors_altair(category=custom_colors)

Plotly

from statworx_theme import apply_custom_colors_plotly
custom_colors = [
    DARK_BLUE := "#0A526B",
    DARK_RED := "#6B0020",
    GREY := "#808285",
]
apply_custom_colors_plotly(category=custom_colors)