charite-plot 0.1.0__tar.gz → 0.2.0__tar.gz

{charite_plot-0.1.0 → charite_plot-0.2.0}/.gitignore

@@ -1,3 +1,4 @@
+dist
 examples/**
 !examples/*.py
 site

charite_plot-0.2.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-07-01
+
+### Added
+
+- `theme_charite` (matplotlib) gained `interactive` and `tiny_margins` parameters.
+- `theme_charite` (Altair) gained `thickness` and `tiny_margins` parameters, bringing it to parity with the matplotlib backend.
+
+### Changed
+
+- Font-size ramp is now shared between both backends: labels scale at 1× and legend text at 0.8× the base size. Altair legend labels are slightly smaller and axis labels slightly larger as a result.
+
+## [0.1.1] - 2026-06-13
+
+### Fixed
+
+- README images now use absolute raw GitHub URLs so they render correctly on PyPI.
+- Corrected PyPI project URLs (homepage, docs, repository, bug tracker).
+
+## [0.1.0] - 2026-06-12
+
+### Added
+
+- Initial release.
+- Matplotlib theme (`mpl_themes.theme_charite`) with `apply_theme()` and `using()` context manager.
+- Altair/Vega-Lite theme (`altair_themes.theme_charite`) with `register()` and `enable()`.
+- 10 built-in colour palettes: `primary`, `secondary`, `mono`, `light`, `versus`, `nineties`, `brickhouse`, `sunrise`, `berryseason`, `goldelse`.
+- 27 Charité corporate identity colour constants in `colors.py`.
+- `make_palette()` for subsampling and interpolating palettes.
+- Font fallback chain: Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif.
+- MkDocs Material documentation with API reference.
+- MIT License.

charite_plot-0.2.0/CITATION.cff

@@ -0,0 +1,19 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin"
+authors:
+  - family-names: Ramezani
+    given-names: Pedram
+    email: pedram.ramezani@charite.de
+version: 0.2.0
+date-released: 2026-07-01
+license: MIT
+url: "https://github.com/pedramezani/charite-plot"
+repository-code: "https://github.com/pedramezani/charite-plot"
+keywords:
+  - matplotlib
+  - altair
+  - theme
+  - visualization
+  - charite

{charite_plot-0.1.0 → charite_plot-0.2.0}/LICENSE.md

@@ -7,3 +7,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 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.
+
+---
+
+This package is based on the original `charite` R package developed by Johannes Julius Mohn (https://github.com/johannesjuliusm/charite), which is also distributed under the MIT License.

{charite_plot-0.1.0 → charite_plot-0.2.0}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: charite-plot
-Version: 0.1.0
+Version: 0.2.0
 Summary: Matplotlib and Altair themes for Charité – Universitätsmedizin Berlin
-Project-URL: Homepage, https://github.com/pedramramezani/charite-plot
-Project-URL: Documentation, https://pedramramezani.github.io/charite-plot
-Project-URL: Repository, https://github.com/pedramramezani/charite-plot
-Project-URL: Bug Tracker, https://github.com/pedramramezani/charite-plot/issues
-Author-email: Pedram Ramezani <pedramramezani.pr@gmail.com>
+Project-URL: Homepage, https://github.com/pedramezani/charite-plot
+Project-URL: Documentation, https://pedramezani.github.io/charite-plot
+Project-URL: Repository, https://github.com/pedramezani/charite-plot
+Project-URL: Bug Tracker, https://github.com/pedramezani/charite-plot/issues
+Project-URL: Changelog, https://github.com/pedramezani/charite-plot/blob/main/CHANGELOG.md
+Author-email: Pedram Ramezani <me@pedramramezani.de>
 License: # MIT License
         
         Copyright 2026 Pedram Ramezani
@@ -16,17 +17,26 @@ License: # MIT License
         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.
+        
+        ---
+        
+        This package is based on the original `charite` R package developed by Johannes Julius Mohn (https://github.com/johannesjuliusm/charite), which is also distributed under the MIT License.
 License-File: LICENSE.md
 Keywords: altair,charite,matplotlib,theme,visualization
 Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Matplotlib
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Requires-Dist: cycler
 Requires-Dist: matplotlib>=3.5
@@ -57,13 +67,13 @@ pip install "charite-plot[altair]"         # with Altair support
 Visualize your data with `theme_charite()` to match the Charité corporate style.
 
 <p align="center">
-<img src="docs/assets/theme_example.png" width="80%"/>
+<img src="https://raw.githubusercontent.com/pedramezani/charite-plot/main/docs/assets/theme_example.png" width="80%"/>
 </p>
 
 Preview the available colour palettes.
 
 <p align="center">
-<img src="docs/assets/palette_preview.png" width="80%"/>
+<img src="https://raw.githubusercontent.com/pedramezani/charite-plot/main/docs/assets/palette_preview.png" width="80%"/>
 </p>
 
 ## Quick start
@@ -126,16 +136,35 @@ enable(palette="berryseason", font_size=13)
 
 The fallback chain follows the official Charité brand guidelines:
 
-**Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans**
-
-> **Ersatzschrift „Calibri"** — Falls die Hausschrift aus technischen Gründen nicht verwendet werden kann, ersetzt die Systemschriftart „Calibri" die Hausschrift. Dies ist beispielsweise bei der E-Mail-Korrespondenz der Fall.
+**Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif**
 
-`DejaVu Sans` ships with Matplotlib and is always available as the final fallback. To override the preferred font:
+`DejaVu Sans` ships with Matplotlib and is always available as the penultimate fallback; `sans-serif` lets the browser or system choose if nothing else matches (important for Altair/Vega-Lite). To override the preferred font:
 
 ```python
 apply_theme(theme_charite(font="Arial"))
 ```
 
+## How to cite
+
+If you use charite-plot in your work, please cite it as:
+
+```bibtex
+@software{ramezani2026chariteplot,
+  author    = {Ramezani, Pedram},
+  title     = {charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin},
+  year      = {2026},
+  version   = {0.2.0},
+  url       = {https://github.com/pedramezani/charite-plot},
+  license   = {MIT},
+}
+```
+
+## Acknowledgements
+
+This package is based on the original [`charite` R package](https://github.com/johannesjuliusm/charite) developed by Johannes Julius Mohn.
+
 ## License
 
 MIT © 2026 Pedram Ramezani
+
+The original `charite` R package by Johannes Julius Mohn is likewise MIT licensed.

{charite_plot-0.1.0 → charite_plot-0.2.0}/README.md

@@ -14,13 +14,13 @@ pip install "charite-plot[altair]"         # with Altair support
 Visualize your data with `theme_charite()` to match the Charité corporate style.
 
 <p align="center">
-<img src="docs/assets/theme_example.png" width="80%"/>
+<img src="https://raw.githubusercontent.com/pedramezani/charite-plot/main/docs/assets/theme_example.png" width="80%"/>
 </p>
 
 Preview the available colour palettes.
 
 <p align="center">
-<img src="docs/assets/palette_preview.png" width="80%"/>
+<img src="https://raw.githubusercontent.com/pedramezani/charite-plot/main/docs/assets/palette_preview.png" width="80%"/>
 </p>
 
 ## Quick start
@@ -83,16 +83,35 @@ enable(palette="berryseason", font_size=13)
 
 The fallback chain follows the official Charité brand guidelines:
 
-**Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans**
+**Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif**
 
-> **Ersatzschrift „Calibri"** — Falls die Hausschrift aus technischen Gründen nicht verwendet werden kann, ersetzt die Systemschriftart „Calibri" die Hausschrift. Dies ist beispielsweise bei der E-Mail-Korrespondenz der Fall.
-
-`DejaVu Sans` ships with Matplotlib and is always available as the final fallback. To override the preferred font:
+`DejaVu Sans` ships with Matplotlib and is always available as the penultimate fallback; `sans-serif` lets the browser or system choose if nothing else matches (important for Altair/Vega-Lite). To override the preferred font:
 
 ```python
 apply_theme(theme_charite(font="Arial"))
 ```
 
+## How to cite
+
+If you use charite-plot in your work, please cite it as:
+
+```bibtex
+@software{ramezani2026chariteplot,
+  author    = {Ramezani, Pedram},
+  title     = {charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin},
+  year      = {2026},
+  version   = {0.2.0},
+  url       = {https://github.com/pedramezani/charite-plot},
+  license   = {MIT},
+}
+```
+
+## Acknowledgements
+
+This package is based on the original [`charite` R package](https://github.com/johannesjuliusm/charite) developed by Johannes Julius Mohn.
+
 ## License
 
 MIT © 2026 Pedram Ramezani
+
+The original `charite` R package by Johannes Julius Mohn is likewise MIT licensed.

{charite_plot-0.1.0 → charite_plot-0.2.0}/charite_plot/__init__.py

@@ -26,5 +26,5 @@ from .palettes import PALETTES, make_palette  # noqa: F401
 from . import mpl_themes  # noqa: F401
 from . import altair_themes  # noqa: F401
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 __author__ = "Pedram Ramezani"

charite_plot-0.2.0/charite_plot/_theme_common.py

@@ -0,0 +1,55 @@
+"""Shared theme primitives for the matplotlib and Altair backends.
+
+These small ``NamedTuple`` structures keep the per-backend theme builders
+readable by giving names to the derived size/margin values. The font-size
+ratios are shared so both backends scale identically from their base size
+(matplotlib works in points, Altair in pixels, but the ratios are the same).
+"""
+
+from typing import NamedTuple
+
+
+class FontSizes(NamedTuple):
+    """Derived font sizes, all scaled from the base ``font_size``."""
+    title: float
+    subtitle: float
+    label: float
+    legend: float
+
+
+class Margins(NamedTuple):
+    """Derived margins/paddings around the plot panel.
+
+    ``wspace`` / ``hspace`` are subplot-spacing fractions used only by the
+    matplotlib backend; they default to ``0`` so the Altair backend can build
+    a ``Margins`` without supplying them.
+    """
+    title: float
+    label: float
+    legend: float
+    wspace: float = 0.0
+    hspace: float = 0.0
+
+
+class Thickness(NamedTuple):
+    """Derived line widths, scaled from the base ``thickness``.
+
+    ``lines`` / ``patches`` are matplotlib-specific defaults; they carry
+    defaults so the Altair backend can build a ``Thickness`` from just the
+    axis-related widths.
+    """
+    axes: float
+    grid: float
+    ticks: float
+    lines: float = 1.5
+    patches: float = 0.0
+
+
+def resolve_font_sizes(font_size: float) -> FontSizes:
+    """Return the standard Charité font-size ramp derived from *font_size*."""
+    return FontSizes(
+        title=round(font_size * 1.2),
+        subtitle=font_size,
+        label=font_size,
+        legend=round(font_size * 0.8),
+    )

{charite_plot-0.1.0 → charite_plot-0.2.0}/charite_plot/altair_themes.py

@@ -8,17 +8,20 @@ Register and enable with::
     enable(font="Arial", font_size=13)    # font override
 """
 
+from __future__ import annotations
+
 from .colors import (
     BLACK, WHITE, TEXT_GREY, PRIME_BLUE, PRIME_LGREY,
     SECOND_DBLUE, KORALL,
 )
 from .palettes import PALETTES
 from .fonts import build_font_stack
+from ._theme_common import Margins, Thickness, resolve_font_sizes
 
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from altair.theme import ThemeConfig
+    from altair.theme import AxisConfigKwds, ThemeConfig
 
 
 def _css_font_stack(preferred: str | None) -> str:
@@ -32,90 +35,109 @@ def _css_font_stack(preferred: str | None) -> str:
 def theme_charite(
     font: str | None = None,
     font_size: int = 12,
+    thickness: float = 0.5,
     grid: bool = False,
     palette: str | list[str] = "primary",
     background: str = "white",
-) -> "ThemeConfig":
+    tiny_margins: bool = False,
+) -> ThemeConfig:
     """Return an Altair theme config dict for the Charité corporate theme.
 
     Parameters
     ----------
     font:
-        Preferred font. Falls back through Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans.
+        Preferred font. Falls back through Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif.
     font_size:
         Base font size in pixels.
+    thickness:
+        Axis line and tick width.
     grid:
         Show axis grid lines.
     palette:
         Built-in palette name or list of hex colors for the categorical range.
     background:
         Chart background color.
+    tiny_margins:
+        Minimise all paddings around the chart.
     """
     colors = PALETTES[palette] if isinstance(palette, str) else list(palette)
-    font_str = _css_font_stack(preferred=font)
-    label_size = font_size - 1
-    title_size = round(font_size * 1.2)
-
-    axis = {
-        "labelFont":     font_str,
-        "titleFont":     font_str,
-        "labelFontSize": label_size,
-        "titleFontSize": font_size,
+    font_stack = _css_font_stack(preferred=font)
+
+    FONT_SIZES = resolve_font_sizes(font_size)
+    MARGINS = Margins(
+        title=8 if tiny_margins else 12,   # chart title offset
+        label=3 if tiny_margins else 6,    # axis / legend title padding
+        legend=2 if tiny_margins else 4,   # legend inner padding
+    )
+    THICKNESS = Thickness(
+        axes=thickness,          # domain line width
+        grid=thickness * 0.8,    # grid line width
+        ticks=thickness,         # tick mark width
+        lines=2,                 # line-mark stroke width (independent of thickness)
+        patches=0.4,             # geoshape stroke width
+    )
+    CHART_PAD = 6 if tiny_margins else 10
+
+    axis: AxisConfigKwds = {
+        "labelFont":     font_stack,
+        "titleFont":     font_stack,
+        "labelFontSize": FONT_SIZES.label,
+        "titleFontSize": FONT_SIZES.subtitle,
         "labelColor":    TEXT_GREY,
         "titleColor":    TEXT_GREY,
-        "titlePadding":  6,
+        "titlePadding":  MARGINS.label,
         "domain":        True,
         "domainColor":   BLACK,
-        "domainWidth":   0.5,
+        "domainWidth":   THICKNESS.axes,
         "ticks":         True,
         "tickColor":     BLACK,
-        "tickWidth":     0.5,
+        "tickWidth":     THICKNESS.ticks,
         "tickSize":      4,
         "grid":          grid,
         "gridColor":     PRIME_LGREY,
-        "gridWidth":     0.4,
-        "gridOpacity":   0.8,
+        "gridWidth":     THICKNESS.grid,
+        "gridOpacity":   0.85,
     }
 
     return {
         "config": {
             "background": background,
-            "font":       font_str,
-            "padding":    {"top": 10, "bottom": 10, "left": 10, "right": 10},
+            "font":       font_stack,
+            "padding":    {"top": CHART_PAD, "bottom": CHART_PAD, "left": CHART_PAD, "right": CHART_PAD},
             "view":  {"stroke": None},
             "axis":  axis,
             "axisX": axis,
             "axisY": axis,
             "legend": {
-                "labelFont":     font_str,
-                "titleFont":     font_str,
-                "labelFontSize": label_size,
-                "titleFontSize": font_size,
+                "labelFont":     font_stack,
+                "titleFont":     font_stack,
+                "labelFontSize": FONT_SIZES.legend,
+                "titleFontSize": FONT_SIZES.subtitle,
                 "labelColor":    TEXT_GREY,
                 "titleColor":    TEXT_GREY,
-                "titlePadding":  6,
-                "padding":       4,
-                "rowPadding":    3,
+                "titlePadding":  MARGINS.label,
+                "padding":       MARGINS.legend,
+                "rowPadding":    FONT_SIZES.legend / 4,
                 "symbolSize":    100,
             },
             "header": {
-                "labelFont":       font_str,
-                "titleFont":       font_str,
-                "labelFontSize":   label_size,
-                "titleFontSize":   font_size,
+                "labelFont":       font_stack,
+                "titleFont":       font_stack,
+                "labelFontSize":   FONT_SIZES.label,
+                "titleFontSize":   FONT_SIZES.subtitle,
                 "labelColor":      WHITE,
                 "titleColor":      PRIME_BLUE,
                 "labelBackground": PRIME_BLUE,
             },
             "title": {
-                "font":             font_str,
-                "subtitleFont":     font_str,
-                "fontSize":         title_size,
-                "subtitleFontSize": font_size,
+                "font":             font_stack,
+                "subtitleFont":     font_stack,
+                "fontSize":         FONT_SIZES.title,
+                "subtitleFontSize": FONT_SIZES.subtitle,
                 "color":            PRIME_BLUE,
                 "subtitleColor":    TEXT_GREY,
                 "anchor":           "middle",
-                "offset":           12,
+                "offset":           MARGINS.title,
             },
             "range": {
                 "category":  colors,
@@ -125,13 +147,13 @@ def theme_charite(
                 "ramp":      ["#ffffff", PRIME_BLUE],
             },
             "bar":      {"color": colors[0], "binSpacing": 1},
-            "line":     {"color": colors[0], "strokeWidth": 2},
+            "line":     {"color": colors[0], "strokeWidth": THICKNESS.lines},
             "point":    {"color": colors[0], "size": 60, "opacity": 0.85, "filled": True},
             "area":     {"color": colors[0], "opacity": 0.8},
             "arc":      {"color": colors[0]},
             "rect":     {"color": colors[0]},
-            "geoshape": {"stroke": WHITE, "strokeWidth": 0.4},
-            "text":     {"font": font_str, "fontSize": label_size, "color": TEXT_GREY},
+            "geoshape": {"stroke": WHITE, "strokeWidth": THICKNESS.patches},
+            "text":     {"font": font_stack, "fontSize": FONT_SIZES.label, "color": TEXT_GREY},
         }
     }
 
@@ -149,7 +171,8 @@ def enable(**kwargs) -> None:
     ----------
     **kwargs:
         Any parameter accepted by ``theme_charite``
-        (``font``, ``font_size``, ``grid``, ``palette``, ``background``).
+        (``font``, ``font_size``, ``thickness``, ``grid``, ``palette``,
+        ``background``, ``tiny_margins``).
 
     Examples
     --------

{charite_plot-0.1.0 → charite_plot-0.2.0}/charite_plot/fonts.py

@@ -2,7 +2,7 @@
 
 import warnings
 
-FONT_STACK = ["Charité Text Office", "Charit? Text Office", "Calibri", "DejaVu Sans"]
+FONT_STACK = ["Charité Text Office", "Charit? Text Office", "Calibri", "DejaVu Sans", "sans-serif"]
 
 
 def _available_fonts() -> set[str]:
@@ -19,7 +19,7 @@ def check_font(font: str) -> bool:
         return True
     warnings.warn(
         f"Font '{font}' is not installed on this system. "
-        "Using the fallback chain: Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans.",
+        "Using the fallback chain: Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif.",
         UserWarning,
         stacklevel=3,
     )