statworx_theme 0.13.0__tar.gz

statworx_theme-0.13.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 An Hoang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

statworx_theme-0.13.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.1
+Name: statworx_theme
+Version: 0.13.0
+Summary: A color theme for matplotlib using the offical statworx design
+Home-page: https://statworx-theme.readthedocs.io/en/latest
+License: MIT
+Keywords: theme,matplotlib,plotting,statworx
+Author: statworx Team
+Author-email: accounts@statworx.com
+Requires-Python: >=3.8,<3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: altair
+Provides-Extra: plotly
+Requires-Dist: altair (>=5.2.0) ; extra == "altair"
+Requires-Dist: nbformat (>=5.4.0) ; extra == "plotly"
+Requires-Dist: plotly (>=5.10.0) ; extra == "plotly"
+Requires-Dist: seaborn (>=0.11.2)
+Requires-Dist: statsmodels (>=0.13.0) ; extra == "plotly"
+Requires-Dist: vega-datasets (>=0.9.0) ; extra == "altair"
+Project-URL: Repository, https://github.com/STATWORX/statworx-theme
+Description-Content-Type: text/markdown
+
+# Statworx Theme
+
+[![PyPI version](https://badge.fury.io/py/statworx-theme.svg)](https://badge.fury.io/py/statworx-theme)
+[![Documentation Status](https://readthedocs.org/projects/statworx-theme/badge/?version=latest)](https://statworx-theme.readthedocs.io/en/latest/?badge=latest)
+[![Release](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml/badge.svg)](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml)
+[![Code Quality](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml/badge.svg)](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml)
+[![Python version](https://img.shields.io/badge/python-3.8-blue.svg)](https://pypi.org/project/kedro/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/STATWORX/statworx-theme/blob/master/LICENSE)
+![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
+
+A color theme plugin for the [matplotlib](https://matplotlib.org/) library and all its derivatives, as well as an optional adaption of this theme for [altair](https://altair-viz.github.io/) and [plotly](https://plotly.com/python/), which automatically applies the official statworx color theme.
+This package also registers commonly used [qualitative color maps](https://matplotlib.org/stable/tutorials/colors/colormaps.html) (such as a fade from good to bad) for use in presentations.
+
+![Sample](./docs/assets/sample.svg)
+
+## Quick Start
+
+Simply install a module with `pip` by using the following command.
+
+```console
+pip install statworx-theme
+```
+
+For usage of altair and plotly extra dependencies need to be installed using pip.
+
+```console
+pip install "statworx-theme[altair]"
+pip install "statworx-theme[plotly]"
+```
+
+For using the styles inside a poetry managed project use `poetry add` with extras.
+```console
+#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:
+
+```python
+from statworx_theme import apply_style
+apply_style()
+```
+
+For applying the plotly or altair style the respective `apply_style_<library>` function is used:
+```python
+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](https://statworx-theme.readthedocs.io/en/latest/gallery.html).
+For a figure gallery using the altair and plotly theme see the respective notebooks inside the [repository](https://github.com/STATWORX/statworx-theme/tree/master/notebooks).
+
+![Sample](./docs/assets/gallery.png)
+
+## 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](https://matplotlib.org/stable/tutorials/introductory/customizing.html)).
+
+```python
+from statworx_theme import apply_custom_colors
+
+custom_colors = [
+    DARK_BLUE := "#0A526B",
+    DARK_RED := "#6B0020",
+    GREY := "#808285",
+]
+apply_custom_colors(custom_colors)
+```
+
+#### Altair
+
+```python
+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
+
+```python
+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)
+```
+

statworx_theme-0.13.0/README.md

@@ -0,0 +1,113 @@
+# Statworx Theme
+
+[![PyPI version](https://badge.fury.io/py/statworx-theme.svg)](https://badge.fury.io/py/statworx-theme)
+[![Documentation Status](https://readthedocs.org/projects/statworx-theme/badge/?version=latest)](https://statworx-theme.readthedocs.io/en/latest/?badge=latest)
+[![Release](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml/badge.svg)](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml)
+[![Code Quality](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml/badge.svg)](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml)
+[![Python version](https://img.shields.io/badge/python-3.8-blue.svg)](https://pypi.org/project/kedro/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/STATWORX/statworx-theme/blob/master/LICENSE)
+![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
+
+A color theme plugin for the [matplotlib](https://matplotlib.org/) library and all its derivatives, as well as an optional adaption of this theme for [altair](https://altair-viz.github.io/) and [plotly](https://plotly.com/python/), which automatically applies the official statworx color theme.
+This package also registers commonly used [qualitative color maps](https://matplotlib.org/stable/tutorials/colors/colormaps.html) (such as a fade from good to bad) for use in presentations.
+
+![Sample](./docs/assets/sample.svg)
+
+## Quick Start
+
+Simply install a module with `pip` by using the following command.
+
+```console
+pip install statworx-theme
+```
+
+For usage of altair and plotly extra dependencies need to be installed using pip.
+
+```console
+pip install "statworx-theme[altair]"
+pip install "statworx-theme[plotly]"
+```
+
+For using the styles inside a poetry managed project use `poetry add` with extras.
+```console
+#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:
+
+```python
+from statworx_theme import apply_style
+apply_style()
+```
+
+For applying the plotly or altair style the respective `apply_style_<library>` function is used:
+```python
+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](https://statworx-theme.readthedocs.io/en/latest/gallery.html).
+For a figure gallery using the altair and plotly theme see the respective notebooks inside the [repository](https://github.com/STATWORX/statworx-theme/tree/master/notebooks).
+
+![Sample](./docs/assets/gallery.png)
+
+## 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](https://matplotlib.org/stable/tutorials/introductory/customizing.html)).
+
+```python
+from statworx_theme import apply_custom_colors
+
+custom_colors = [
+    DARK_BLUE := "#0A526B",
+    DARK_RED := "#6B0020",
+    GREY := "#808285",
+]
+apply_custom_colors(custom_colors)
+```
+
+#### Altair
+
+```python
+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
+
+```python
+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)
+```

statworx_theme-0.13.0/pyproject.toml

@@ -0,0 +1,45 @@
+[tool.poetry]
+name = "statworx_theme"
+version = "0.13.0"
+description = "A color theme for matplotlib using the offical statworx design"
+authors = [
+  "statworx Team <accounts@statworx.com>",
+  "An Hoang <an.hoang@statworx.com>",
+  "Benedikt Batton <benedikt.batton@statworx.com>",
+]
+readme = "README.md"
+license = "MIT"
+keywords = ["theme", "matplotlib", "plotting", "statworx"]
+repository = "https://github.com/STATWORX/statworx-theme"
+homepage = "https://statworx-theme.readthedocs.io/en/latest"
+
+[tool.poetry.dependencies]
+python = ">=3.8,<3.12"
+seaborn = ">=0.11.2"
+altair = { version = ">=5.2.0", optional = true }
+plotly = { version = ">=5.10.0", optional = true }
+nbformat = { version = ">=5.4.0", optional = true }
+vega-datasets = { version = ">=0.9.0", optional = true }
+statsmodels = { version = ">=0.13.0", optional = true }
+
+[tool.poetry.dev-dependencies]
+black = ">=22.3.0"
+commitizen = ">=2.21.2"
+darglint = ">=1.8.1"
+flake8 = ">=4.0.1"
+ipykernel = ">=6.9.2"
+mkdocs = ">=1.3.0"
+mkdocs-material = ">=8.2.8"
+mkdocstrings = ">=0.18.1"
+mkdocstrings-python = ">=0.6.6"
+mkdocs-matplotlib = ">=0.8.3"
+pre-commit = ">=2.18.0"
+mkdocs-include-markdown-plugin = "^3.3.0"
+
+[tool.poetry.extras]
+altair = ["altair", "vega-datasets"]
+plotly = ["plotly", "nbformat", "statsmodels"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

statworx_theme-0.13.0/src/statworx_theme/__init__.py

@@ -0,0 +1,16 @@
+"""statworx_theme module."""
+
+from .colormaps import *
+from .utils import (  # unimport:skip
+    apply_custom_colors,
+    apply_custom_colors_altair,
+    apply_custom_colors_plotly,
+    apply_style,
+    apply_style_altair,
+    apply_style_plotly,
+    get_stwx_cmaps,
+    register_blended_cmap,
+    register_listed_cmap,
+)
+
+__version__ = "0.13.0"

statworx_theme-0.13.0/src/statworx_theme/colormaps.py

@@ -0,0 +1,94 @@
+"""Colormaps for the statworx theme."""
+from itertools import product
+
+from .colors import (
+    BLACK,
+    BLUE,
+    COLOR_DICT,
+    DARK_GREEN,
+    DARK_RED,
+    DEEP_BLUE,
+    DEEP_CYAN,
+    DEEP_GREEN,
+    DEEP_GREY,
+    DEEP_ORANGE,
+    DEEP_RED,
+    DEEP_VIOLET,
+    DEEP_YELLOW,
+    LIGHT_BLUE,
+    LIGHT_GREEN,
+    LIGHT_GREY,
+    LIGHT_RED,
+    WHITE,
+)
+from .utils import register_blended_cmap, register_listed_cmap
+
+####################################################################################################
+# DISCRETE COLORMAPS
+####################################################################################################
+
+standard_colors = [
+    BLUE,
+    LIGHT_GREY,
+    LIGHT_BLUE,
+    DEEP_GREY,
+    DARK_RED,
+    LIGHT_GREEN,
+    LIGHT_RED,
+    DARK_GREEN,
+]
+standard_cmap = register_listed_cmap(standard_colors, "stwx:standard")
+
+alternative_colors = [
+    BLUE,
+    LIGHT_GREY,
+    DARK_RED,
+    LIGHT_GREEN,
+    LIGHT_BLUE,
+    DEEP_GREY,
+    LIGHT_RED,
+    DARK_GREEN,
+]
+alternative_cmap = register_listed_cmap(alternative_colors, "stwx:alternative")
+
+
+deep_colors = [
+    DEEP_BLUE,
+    DEEP_RED,
+    DEEP_GREEN,
+    DEEP_VIOLET,
+    DEEP_CYAN,
+    DEEP_ORANGE,
+]
+deep_cmap = register_listed_cmap(deep_colors, "stwx:deep")
+
+####################################################################################################
+# BLENDED COLORMAPS
+####################################################################################################
+
+bad2good_colors = [DARK_RED, DEEP_YELLOW, DARK_GREEN]
+bad2good_cmap = register_blended_cmap(bad2good_colors, "stwx:bad2good")
+
+good2bad_colors = [DARK_GREEN, DEEP_YELLOW, DARK_RED]
+good2bad_cmap = register_blended_cmap(good2bad_colors, "stwx:good2bad")
+
+for (name1, color1), (name2, color2) in product(COLOR_DICT.items(), COLOR_DICT.items()):
+    cmap_colors_ = [color1, WHITE, color2]
+    cmap_name_ = f"stwx:{name1}{name2}_diverging"
+    register_blended_cmap(cmap_colors_, cmap_name_)
+
+for (name1, color1), (name2, color2) in product(COLOR_DICT.items(), COLOR_DICT.items()):
+    if name1 != name2:
+        cmap_colors_ = [color1, color2]
+        cmap_name_ = f"stwx:{name1}{name2}_blend"
+        register_blended_cmap(cmap_colors_, cmap_name_)
+
+for name, color in COLOR_DICT.items():
+    cmap_colors_ = [color, WHITE]
+    cmap_name_ = f"stwx:{name}_fade"
+    register_blended_cmap(cmap_colors_, cmap_name_)
+
+for name, color in COLOR_DICT.items():
+    cmap_colors_ = [BLACK, color, WHITE]
+    cmap_name_ = f"stwx:{name}_rise"
+    register_blended_cmap(cmap_colors_, cmap_name_)

statworx_theme-0.13.0/src/statworx_theme/colors.py

@@ -0,0 +1,59 @@
+"""Color definitions for the statworx theme."""
+from typing import Dict
+
+# black and white
+BLACK = "#000000"
+WHITE = "#FFFFFF"
+
+# GREY
+DEEP_GREY = "#6C7D8C"
+DARK_GREY = "#7D8AA4"
+DARKER_GREY = "#283440"
+GRAY = "#B6BDCC"
+LIGHT_GREY = "#9BAEC1"
+LIGHTER_GREY = "#EBF0F2"
+
+# YELLOW
+DEEP_YELLOW = "#FFFF00"
+
+# VIOLEt
+DEEP_VIOLET = "#7f00ff"
+
+# CYAN
+DEEP_CYAN = "#01BAEF"
+
+# ORANGE
+DEEP_ORANGE = "#FF781F"
+
+# BLUE
+DEEP_BLUE = "#0000FF"
+BLUE = "#0000BF"
+LIGHT_BLUE = "#9999FF"
+
+# RED
+DARK_RED = "#C7014F"
+DEEP_RED = "#FE0D6C"
+LIGHT_RED = "#FF9EC4"
+
+# GREEN
+DEEP_GREEN = "#00C800"
+LIGHT_GREEN = "#83FF83"
+DARK_GREEN = "#009600"
+
+# define standard colors
+C0 = BLUE
+C1 = LIGHT_GREY
+C2 = LIGHT_BLUE
+C3 = DEEP_GREY
+C4 = DARK_RED
+C5 = LIGHT_GREEN
+C6 = LIGHT_RED
+C7 = DARK_GREEN
+
+# create color dict
+COLOR_DICT: Dict[str, str] = {
+    "Rd": DARK_RED,
+    "Bl": BLUE,
+    "Gn": DARK_GREEN,
+    "Yw": DEEP_YELLOW,
+}