# Statworx Theme
[](https://badge.fury.io/py/statworx-theme)
[](https://statworx-theme.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml)
[](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml)
[](https://pypi.org/project/kedro/)
[](https://github.com/STATWORX/statworx-theme/blob/master/LICENSE)
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.
## 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).
## 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)
```
Raw data
{
"_id": null,
"home_page": "https://statworx-theme.readthedocs.io/en/latest",
"name": "statworx-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "theme,matplotlib,plotting,statworx",
"author": "statworx Team",
"author_email": "accounts@statworx.com",
"download_url": "https://files.pythonhosted.org/packages/21/03/c72aeb46b6fc9dc4e554d6d11156f2b3361592fb63cf0040e1a6c9582d71/statworx_theme-0.12.1.tar.gz",
"platform": null,
"description": "# Statworx Theme\n\n[](https://badge.fury.io/py/statworx-theme)\n[](https://statworx-theme.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/STATWORX/statworx-theme/actions/workflows/release.yml)\n[](https://github.com/STATWORX/statworx-theme/actions/workflows/conde_quality.yml)\n[](https://pypi.org/project/kedro/)\n[](https://github.com/STATWORX/statworx-theme/blob/master/LICENSE)\n\n\nA 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.\nThis 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.\n\n\n\n## Quick Start\n\nSimply install a module with `pip` by using the following command.\n\n```console\npip install statworx-theme\n```\n\nFor usage of altair and plotly extra dependencies need to be installed using pip.\n\n```console\npip install \"statworx-theme[altair]\"\npip install \"statworx-theme[plotly]\"\n```\n\nFor using the styles inside a poetry managed project use `poetry add` with extras.\n```console\n#only matplotlib\npoetry add statworx-theme\n\n# altair theme\npoetry add statworx-theme -E \"altair\"\n\n# plotly theme\npoetry add statworx-theme -E \"plotly\"\n\n# Whole package\npoetry add statworx-theme -E \"altair plotly\"\n```\n\n\nTo apply the matplotlib style, you must call the `apply_style` function by typing:\n\n```python\nfrom statworx_theme import apply_style\napply_style()\n```\n\nFor applying the plotly or altair style the respective `apply_style_<library>` function is used:\n```python\nfrom statworx_theme import apply_style_altair, apply_style_plotly\napply_style_altair()\napply_style_plotly()\n```\n\n\n## Gallery\n\n#### Matplotlib\nThere 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).\nFor 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).\n\n\n\n## Custom Colors\n\nYou can also use a custom list of color for the color scheme beside the official statworx colors.\nThere is a convenience function for that which is described below.\nThis simply changes the colors.\n\n##### Matplotlib\nIn 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)).\n\n```python\nfrom statworx_theme import apply_custom_colors\n\ncustom_colors = [\n DARK_BLUE := \"#0A526B\",\n DARK_RED := \"#6B0020\",\n GREY := \"#808285\",\n]\napply_custom_colors(custom_colors)\n```\n\n#### Altair\n\n```python\nfrom statworx_theme import apply_custom_colors_altair\n\ncustom_colors = [\n DARK_BLUE := \"#0A526B\",\n DARK_RED := \"#6B0020\",\n GREY := \"#808285\",\n]\napply_custom_colors_altair(category=custom_colors)\n```\n\n#### Plotly\n\n```python\nfrom statworx_theme import apply_custom_colors_plotly\ncustom_colors = [\n DARK_BLUE := \"#0A526B\",\n DARK_RED := \"#6B0020\",\n GREY := \"#808285\",\n]\napply_custom_colors_plotly(category=custom_colors)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A color theme for matplotlib using the offical statworx design",
"version": "0.12.1",
"project_urls": {
"Homepage": "https://statworx-theme.readthedocs.io/en/latest",
"Repository": "https://github.com/STATWORX/statworx-theme"
},
"split_keywords": [
"theme",
"matplotlib",
"plotting",
"statworx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d8675fa21b28a8a9f007cb623cd594841e8ac707061537a5ee2777b2ae3f886",
"md5": "3556768d797f303ee61075657aac436d",
"sha256": "886dc9033f3b0757d43cbfb9b71693952ed067406a692ce8a61ab4d918cf2add"
},
"downloads": -1,
"filename": "statworx_theme-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3556768d797f303ee61075657aac436d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 21112,
"upload_time": "2023-08-09T08:17:19",
"upload_time_iso_8601": "2023-08-09T08:17:19.712299Z",
"url": "https://files.pythonhosted.org/packages/1d/86/75fa21b28a8a9f007cb623cd594841e8ac707061537a5ee2777b2ae3f886/statworx_theme-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2103c72aeb46b6fc9dc4e554d6d11156f2b3361592fb63cf0040e1a6c9582d71",
"md5": "2475b0f61d81ada0175b80088f5e105f",
"sha256": "ee8cf8fbe373bbd6110e45a822ad434d0f7930bc5efe27b4022a6906cc27cd96"
},
"downloads": -1,
"filename": "statworx_theme-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "2475b0f61d81ada0175b80088f5e105f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 21072,
"upload_time": "2023-08-09T08:17:21",
"upload_time_iso_8601": "2023-08-09T08:17:21.380235Z",
"url": "https://files.pythonhosted.org/packages/21/03/c72aeb46b6fc9dc4e554d6d11156f2b3361592fb63cf0040e1a6c9582d71/statworx_theme-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-09 08:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "STATWORX",
"github_project": "statworx-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "statworx-theme"
}
JSON
