matplotlib-sankey 0.3.1__tar.gz → 0.3.2__tar.gz

{matplotlib_sankey-0.3.1 → matplotlib_sankey-0.3.2}/PKG-INFO

@@ -1,49 +1,46 @@
 Metadata-Version: 2.4
 Name: matplotlib-sankey
-Version: 0.3.1
-Summary: Sankey plot for matplotlib
+Version: 0.3.2
+Summary: Create Sankey diagrams with Matplotlib.
 Author: harryhaller001
-Maintainer-email: harryhaller001 <harryhaller001@gmail.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
+Author-email: harryhaller001 <harryhaller001@gmail.com>
+License-Expression: MIT
 Classifier: Development Status :: 3 - Alpha
-Classifier: Framework :: Matplotlib
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
-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: Typing :: Typed
-License-File: LICENSE
 Requires-Dist: matplotlib
-Requires-Dist: numpy
-Requires-Dist: ipykernel ; extra == "docs"
-Requires-Dist: ipython ; extra == "docs"
-Requires-Dist: ipywidgets ; extra == "docs"
-Requires-Dist: myst-parser ; extra == "docs"
-Requires-Dist: nbsphinx ; extra == "docs"
-Requires-Dist: networkx[default] ; extra == "docs"
-Requires-Dist: sphinx>=4 ; extra == "docs"
-Requires-Dist: sphinx-autoapi ; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
-Requires-Dist: sphinx-book-theme>=1 ; extra == "docs"
-Requires-Dist: coverage ; extra == "test"
-Requires-Dist: flit ; extra == "test"
-Requires-Dist: mypy ; extra == "test"
-Requires-Dist: pre-commit ; extra == "test"
-Requires-Dist: pytest ; extra == "test"
-Requires-Dist: ruff ; extra == "test"
-Requires-Dist: setuptools ; extra == "test"
-Requires-Dist: twine>=4.0.2 ; extra == "test"
-Project-URL: Documentation, https://harryhaller001.github.io/matplotlib-sankey/
-Project-URL: Homepage, https://github.com/harryhaller001/matplotlib-sankey
+Requires-Dist: ipython ; extra == 'docs'
+Requires-Dist: myst-parser ; extra == 'docs'
+Requires-Dist: nbsphinx ; extra == 'docs'
+Requires-Dist: sphinx ; extra == 'docs'
+Requires-Dist: sphinx-autoapi ; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
+Requires-Dist: sphinx-book-theme ; extra == 'docs'
+Requires-Dist: coverage ; extra == 'test'
+Requires-Dist: ipykernel ; extra == 'test'
+Requires-Dist: ipython ; extra == 'test'
+Requires-Dist: ipywidgets ; extra == 'test'
+Requires-Dist: pre-commit ; extra == 'test'
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: responses ; extra == 'test'
+Requires-Dist: ruff ; extra == 'test'
+Requires-Dist: twine ; extra == 'test'
+Requires-Dist: ty>=0.0.16 ; extra == 'test'
+Requires-Dist: types-requests ; extra == 'test'
+Maintainer: harryhaller001
+Maintainer-email: harryhaller001 <harryhaller001@gmail.com>
+Requires-Python: >=3.11
 Project-URL: Source, https://github.com/harryhaller001/matplotlib-sankey
 Provides-Extra: docs
 Provides-Extra: test
+Description-Content-Type: text/markdown
 
 # matplotlib-sankey
 
@@ -59,16 +56,20 @@ Sankey plot for matplotlib
 
 ### Installation
 
-Install with pip:
+Install with `pip`:
 
 `pip install matplotlib-sankey`
 
+Install with `uv`:
+
+`uv add matplotlib-sankey`
+
 Install from source:
 
 ```bash
 git clone https://github.com/harryhaller001/matplotlib-sankey
 cd matplotlib-sankey
-pip install .
+pip install -e .
 ```
 
 
@@ -100,10 +101,15 @@ sankey(
 ### Development
 
 ```bash
-python3.10 -m virtualenv venv
-source venv/bin/activate
+git clone https://github.com/harryhaller001/matplotlib-sankey
+cd matplotlib-sankey
+
+# Create virtual env with uv
+uv venv
 
 # Install dev dependencies
 make install
-```
 
+# Run all checks
+make check
+```

{matplotlib_sankey-0.3.1 → matplotlib_sankey-0.3.2}/README.md

@@ -12,16 +12,20 @@ Sankey plot for matplotlib
 
 ### Installation
 
-Install with pip:
+Install with `pip`:
 
 `pip install matplotlib-sankey`
 
+Install with `uv`:
+
+`uv add matplotlib-sankey`
+
 Install from source:
 
 ```bash
 git clone https://github.com/harryhaller001/matplotlib-sankey
 cd matplotlib-sankey
-pip install .
+pip install -e .
 ```
 
 
@@ -53,9 +57,15 @@ sankey(
 ### Development
 
 ```bash
-python3.10 -m virtualenv venv
-source venv/bin/activate
+git clone https://github.com/harryhaller001/matplotlib-sankey
+cd matplotlib-sankey
+
+# Create virtual env with uv
+uv venv
 
 # Install dev dependencies
 make install
+
+# Run all checks
+make check
 ```

matplotlib_sankey-0.3.2/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+build-backend = "uv_build"
+requires = [ "uv-build>=0.9.28,<0.10" ]
+
+[project]
+name = "matplotlib-sankey"
+version = "0.3.2"
+description = "Create Sankey diagrams with Matplotlib."
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+maintainers = [ { name = "harryhaller001", email = "harryhaller001@gmail.com" } ]
+authors = [ { name = "harryhaller001", email = "harryhaller001@gmail.com" } ]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+dependencies = [ "matplotlib" ]
+optional-dependencies.docs = [
+    "ipython",                  # Required for syntax highlighing (https://github.com/spatialaudio/nbsphinx/issues/24)
+    "myst-parser",
+    "nbsphinx",
+    "sphinx",
+    "sphinx-autoapi",
+    "sphinx-autodoc-typehints",
+    "sphinx-book-theme",
+]
+optional-dependencies.test = [
+    "coverage",
+    "ipykernel",
+    "ipython",
+    "ipywidgets",
+    "pre-commit",
+    "pytest",
+    "responses",
+    "ruff",
+    "twine",
+    "ty>=0.0.16",
+    "types-requests",
+]
+urls.Source = "https://github.com/harryhaller001/matplotlib-sankey"
+
+[tool.ruff]
+line-length = 120
+extend-include = [ "*.ipynb" ]
+format.docstring-code-format = true
+lint.select = [ "B", "BLE", "C4", "D", "E", "F", "I", "RUF100", "TID", "UP", "W" ]
+lint.ignore = [ "B008", "C408", "D100", "D104", "D105", "D107", "D203", "D213", "D400", "D401", "E501", "E731", "E741" ]
+lint.per-file-ignores."*/__init__.py" = [ "F401" ]
+lint.per-file-ignores."docs/*" = [ "I" ]
+lint.per-file-ignores."test/*" = [ "D" ]
+lint.pydocstyle.convention = "google"
+
+[tool.pyproject-fmt]
+column_width = 120            # after how many column width split arrays/dicts into multiple lines, 1 will force always
+indent = 4
+keep_full_version = false     # if false will remove unnecessary trailing ``.0``'s from version specifiers
+max_supported_python = "3.14" # maximum Python version to use when generating version specifiers
+
+[tool.pytest]
+ini_options.minversion = "7.0"
+ini_options.log_format = "%(asctime)s %(levelname)s %(message)s"
+ini_options.log_date_format = "%Y-%m-%d %H:%M:%S"
+ini_options.log_level = "INFO"
+ini_options.log_cli = true
+ini_options.python_files = "test_*.py"
+ini_options.testpaths = [ "tests" ]
+ini_options.xfail_strict = true
+ini_options.addopts = [
+    "--import-mode=importlib", # allow using test files with same name
+]
+
+[tool.coverage]
+run.omit = [ "*/tests/*" ]
+run.source = [ "src/matplotlib_sankey" ]
+report.exclude_lines = [ "raise" ]
+report.ignore_errors = true
+html.directory = "coverage_report"
+
+[tool.uv]
+package = true

matplotlib_sankey-0.3.2/src/matplotlib_sankey/__init__.py

@@ -0,0 +1,5 @@
+from matplotlib_sankey._plotting import sankey
+from matplotlib_sankey._utils import from_matrix
+from matplotlib_sankey._version import __version__
+
+__all__ = ["sankey", "__version__", "from_matrix"]

{matplotlib_sankey-0.3.1 → matplotlib_sankey-0.3.2/src}/matplotlib_sankey/_colors.py

@@ -1,11 +1,11 @@
-from typing import Any
 import re
-from matplotlib.colors import get_named_colors_mapping, Normalize, to_rgb
-
-from ._utils import isinstance_list_of
-from ._types import ColorTuple
+from typing import Any
 
 from matplotlib import colormaps
+from matplotlib.colors import Normalize, get_named_colors_mapping, to_rgb
+
+from matplotlib_sankey._types import ColorTuple
+from matplotlib_sankey._utils import isinstance_list_of
 
 
 def is_colormap(name: str) -> bool:

{matplotlib_sankey-0.3.1 → matplotlib_sankey-0.3.2/src}/matplotlib_sankey/_plotting.py

@@ -1,16 +1,16 @@
 from collections.abc import Sequence
-from typing import Literal, Any
+from typing import Any, Literal, cast
 
 import matplotlib.pyplot as plt
 from matplotlib.axes import Axes
-from matplotlib.patches import Rectangle, PathPatch, Patch
-from matplotlib.ticker import FixedLocator
 from matplotlib.colors import Colormap
+from matplotlib.patches import Patch, PathPatch, Rectangle
+from matplotlib.ticker import FixedLocator
 
-from ._types import CurveType, ColorTuple
-from ._utils import _clean_axis, is_light_color
-from ._patches import patch_curve3, patch_curve4, patch_line
-from ._colors import colormap_to_list, is_color, is_colormap, unify_color
+from matplotlib_sankey._colors import colormap_to_list, is_color, is_colormap, unify_color
+from matplotlib_sankey._patches import patch_curve3, patch_curve4, patch_line
+from matplotlib_sankey._types import ColorTuple, CurveType
+from matplotlib_sankey._utils import _clean_axis, is_light_color
 
 
 def sankey(
@@ -27,7 +27,10 @@ def sankey(
     | Sequence[Colormap]
     | str
     | Sequence[tuple[float, float, float]]
-    | Sequence[tuple[float, float, float, float]] = "tab10",
+    | Sequence[tuple[float, float, float, float]]
+    | Sequence[
+        str | Sequence[str] | Colormap | tuple[float, float, float] | tuple[float, float, float, float]
+    ] = "tab10",
     curve_type: CurveType = "curve4",
     ribbon_alpha: float = 0.2,
     ribbon_color: str = "black",
@@ -38,6 +41,7 @@ def sankey(
     column_labels: list[str] | None = None,
     annotate_columns_font_kwargs: dict[str, Any] | None = None,
     annotate_columns_font_color: Literal["auto"] | ColorTuple | str = "auto",
+    column_item_totals: list[dict[int | str, float | int]] | None = None,
 ) -> Axes:
     """Sankey plot.
 
@@ -60,6 +64,7 @@ def sankey(
         column_labels (list[str] | None, optional): Labels for columns. Defaults to `None`.
         annotate_columns_font_kwargs (dict[str, Any] | None, optional): Extra arguments for column `ax.text` method of column annotation. Defaults to `None`.
         annotate_columns_font_color (Literal["auto"] | ColorTuple | str, optional): Color of column annotation text. Defaults to `"auto"`, thereby automatically selectes text color based on background color.
+        column_item_totals (list[dict[int | str, float | int]] | None, optional): Total values for each column item. If provided, column items are sized based on these totals instead of the sum of ribbon weights. Ribbons are adjusted proportionally within the column items. Defaults to `None`.
 
     Returns:
         Matplotlib axes instance.
@@ -108,6 +113,24 @@ def sankey(
                         column_weights[frame_index + 1].get(target_index, 0) + weight
                     )
 
+    # Validate column_item_totals if provided
+    if column_item_totals is not None:
+        assert len(column_item_totals) == ncols, f"column_item_totals must have {ncols} entries, one for each column."
+        for col_index in range(ncols):
+            for item_key in column_weights[col_index].keys():
+                if item_key not in column_item_totals[col_index]:
+                    raise ValueError(
+                        f"Column {col_index}, item '{item_key}' has ribbons but no total value provided in column_item_totals."
+                    )
+                if column_item_totals[col_index][item_key] < column_weights[col_index][item_key]:
+                    raise ValueError(
+                        f"Column {col_index}, item '{item_key}': total value {column_item_totals[col_index][item_key]} "
+                        f"is less than sum of ribbon weights {column_weights[col_index][item_key]}."
+                    )
+
+    # Use totals for rectangle sizing if provided, otherwise use calculated weights
+    column_display_weights = column_item_totals if column_item_totals is not None else column_weights
+
     # Total number of column rects
     total_rects: int = sum([len(col.keys()) for col in column_weights])
 
@@ -139,31 +162,35 @@ def sankey(
             raise ValueError("If cmap argument is a string, please provide color name, hex code or name of colormap.")
 
     elif isinstance(color, list | tuple | set):
-        assert len(color) == ncols
+        # Type narrowing: at this point we know color is a sequence
+        color_seq = cast(Sequence[Any], color)
+        assert len(color_seq) == ncols
         # process column wise definition of color
         for col_index in range(len(column_rect_counts)):
             new_column = []
+            col_color = color_seq[col_index]
 
-            if isinstance(color[col_index], str) and is_colormap(color[col_index]):
+            if isinstance(col_color, str) and is_colormap(col_color):
                 for rect_index in range(column_rect_counts[col_index]):
                     new_column.append(
                         colormap_to_list(
-                            name=color[col_index],
+                            name=col_color,
                             num=len(column_weights[col_index].keys()),
                             rollover=True,
                         )[rect_index]
                     )
-            elif is_color(color[col_index]):
+            elif is_color(col_color):
                 for _ in range(column_rect_counts[col_index]):
-                    new_column.append(unify_color(color[col_index]))
+                    new_column.append(unify_color(col_color))
 
-            elif isinstance(color[col_index], list | tuple | set):
+            elif isinstance(col_color, list | tuple | set):
                 # List of list -> individual definition of column rect color
-                assert all(is_color(c) for c in color[col_index]), "All items must be a color."
-                assert len(color[col_index]) == column_rect_counts[col_index]
+                col_color_seq = cast(Sequence[Any], col_color)
+                assert all(is_color(c) for c in col_color_seq), "All items must be a color."
+                assert len(col_color_seq) == column_rect_counts[col_index]
 
                 for rect_index in range(column_rect_counts[col_index]):
-                    new_column.append(unify_color(color[col_index][rect_index]))
+                    new_column.append(unify_color(col_color_seq[rect_index]))
 
             color_matrix.append(new_column)
 
@@ -177,14 +204,14 @@ def sankey(
     legend_handles: list[tuple[str, ColorTuple]] = []
 
     for frame_index in range(ncols):
-        column_total_weight = sum(column_weights[frame_index].values())
+        column_total_weight = sum(column_display_weights[frame_index].values())
         column_prev_weight = 0.0
 
-        column_n_spacing = len(column_weights[frame_index].values()) - 1
+        column_n_spacing = len(column_display_weights[frame_index].values()) - 1
 
         spacing_scale_factor = 1 - (spacing * column_n_spacing)
 
-        for column_index, (column_key, weights) in enumerate(column_weights[frame_index].items()):
+        for column_index, (column_key, weights) in enumerate(column_display_weights[frame_index].items()):
             rect_x = frame_index - (rel_column_width / 2)
             rect_y = column_prev_weight / column_total_weight + (column_index * spacing)
             rect_height = (weights * spacing_scale_factor) / column_total_weight
@@ -281,25 +308,23 @@ def sankey(
             ribbon_offset: float = 0.0
 
             for target_index, ribbon_weight in column_targets.items():
-                # Start coords
-                y1_start = rect_y + +(rect_height * (ribbon_offset / sum(column_targets.values())))
-                y2_end = rect_y + (rect_height * ((ribbon_offset + ribbon_weight) / sum(column_targets.values())))
+                # Start coords - use actual ribbon weights for positioning within source rectangle
+                source_item_total = column_display_weights[frame_index][column_key]
+                y1_start = rect_y + (rect_height * (ribbon_offset / source_item_total))
+                y2_end = rect_y + (rect_height * ((ribbon_offset + ribbon_weight) / source_item_total))
 
                 ribbon_offset += ribbon_weight
 
                 _, target_rect_y, _, target_rect_height = column_rects[frame_index + 1][target_index]
 
-                # End coords
+                # End coords - use actual ribbon weights for positioning within target rectangle
+                target_item_total = column_display_weights[frame_index + 1][target_index]
                 y1_end = target_rect_y + (
-                    target_rect_height
-                    * (target_ribbon_offset.get(target_index, 0) / column_weights[frame_index + 1][target_index])
+                    target_rect_height * (target_ribbon_offset.get(target_index, 0) / target_item_total)
                 )
                 y2_start = target_rect_y + (
                     target_rect_height
-                    * (
-                        (ribbon_weight + target_ribbon_offset.get(target_index, 0))
-                        / column_weights[frame_index + 1][target_index]
-                    )
+                    * ((ribbon_weight + target_ribbon_offset.get(target_index, 0)) / target_item_total)
                 )
 
                 target_ribbon_offset[target_index] = target_ribbon_offset.get(target_index, 0) + ribbon_weight

{matplotlib_sankey-0.3.1 → matplotlib_sankey-0.3.2/src}/matplotlib_sankey/_utils.py

@@ -1,13 +1,13 @@
 from collections.abc import Sequence
-from typing import Any, Literal
 from types import UnionType
+from typing import Any, Literal
 
 import numpy as np
 from matplotlib import colormaps
 from matplotlib.axes import Axes
-from matplotlib.colors import Colormap, ListedColormap
+from matplotlib.colors import Colormap, ListedColormap, to_rgb
 
-from ._types import AcceptedColors, ColorTuple
+from matplotlib_sankey._types import AcceptedColors, ColorTuple
 
 
 def _clean_axis(
@@ -51,7 +51,12 @@ def _generate_cmap(value: AcceptedColors, nrows: int) -> Colormap:
         return _convert_sequential_cmap_to_listed(colormaps.get_cmap(value))
 
     elif isinstance(value, Sequence):
-        return ListedColormap(value)
+        # Convert color names/strings to RGB tuples for ListedColormap
+        rgb_colors: list[tuple[float, float, float]] = [
+            to_rgb(c) if isinstance(c, str) else tuple(c)  # type: ignore[arg-type]
+            for c in value
+        ]
+        return ListedColormap(rgb_colors)
 
     elif isinstance(value, Colormap):
         return _convert_sequential_cmap_to_listed(value)

matplotlib_sankey-0.3.2/src/matplotlib_sankey/_version.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__: str = version("matplotlib-sankey")

matplotlib_sankey-0.3.1/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[{*.{yml,yaml,toml},.cruft.json}]
-indent_size = 2
-
-[Makefile]
-indent_style = tab

matplotlib_sankey-0.3.1/.gitignore

@@ -1,164 +0,0 @@
-/docs/coverage_report
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/

matplotlib_sankey-0.3.1/CITATION.cff

@@ -1,16 +0,0 @@
-cff-version: 1.2.0
-message: "If you use matplotlib-sankey, please cite it as below."
-authors:
-  - family-names: "Hellmig"
-    given-names: "Malte"
-    orcid: "https://orcid.org/0000-0002-6692-5618"
-  - family-names: "Krebs"
-    given-names: "Christian F."
-    orcid: "https://orcid.org/0000-0003-2739-5578"
-title: "matplotlib-sankey"
-version: 0.3.0
-date-released: 2025-05-14
-url: "https://github.com/harryhaller001/matplotlib-sankey"
-identifiers:
-  - type: doi
-    value: 10.5281/zenodo.15420062

matplotlib_sankey-0.3.1/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 harryhaller001
-
-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.

matplotlib_sankey-0.3.1/matplotlib_sankey/__init__.py

@@ -1,5 +0,0 @@
-from ._plotting import sankey
-from ._version import __version__
-from ._utils import from_matrix
-
-__all__ = ["sankey", "__version__", "from_matrix"]

matplotlib_sankey-0.3.1/matplotlib_sankey/_version.py

@@ -1 +0,0 @@
-__version__ = "0.3.1"

matplotlib_sankey-0.3.1/pyproject.toml

@@ -1,160 +0,0 @@
-[build-system]
-# Package build system
-build-backend = "flit_core.buildapi"
-requires = [ "flit-core>=3.2,<4" ]
-
-[project]
-name = "matplotlib-sankey"
-description = "Sankey plot for matplotlib"
-readme = { file = "README.md", content-type = "text/markdown" }
-
-license = { file = "LICENSE" }
-
-maintainers = [ { name = "harryhaller001", email = "harryhaller001@gmail.com" } ]
-authors = [ { name = "harryhaller001" } ]
-
-requires-python = ">=3.10"
-
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Framework :: Matplotlib",
-    "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
-    "Natural Language :: English",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Typing :: Typed",
-]
-dynamic = [ "version" ]
-
-dependencies = [ "matplotlib", "numpy" ]
-
-optional-dependencies.docs = [
-    "ipykernel",
-    "ipython",
-    "ipywidgets",
-    "myst-parser",
-    "nbsphinx",
-    "networkx[default]",
-    "sphinx>=4",
-    "sphinx-autoapi",
-    "sphinx-autodoc-typehints",
-    "sphinx-book-theme>=1",
-]
-optional-dependencies.test = [
-    "coverage",
-    "flit",
-    "mypy",
-    "pre-commit",
-    "pytest",
-    "ruff",
-    "setuptools",
-    "twine>=4.0.2",
-]
-
-# https://docs.pypi.org/project_metadata/#project-urls
-urls.Documentation = "https://harryhaller001.github.io/matplotlib-sankey/"
-urls.Homepage = "https://github.com/harryhaller001/matplotlib-sankey"
-urls.Source = "https://github.com/harryhaller001/matplotlib-sankey"
-
-[tool.flit.sdist]
-include = [ "matplotlib_sankey/", "tests/" ]
-exclude = [
-    "docs/",
-    "coverage",
-    ".git/",
-    ".github/",
-    ".pre-commit-config.yaml",
-    "Makefile",
-    ".python-version",
-    # "requirements.txt",
-    ".vscode/",
-    "dev/",
-]
-
-[tool.ruff]
-line-length = 120
-extend-include = [ "*.ipynb" ]
-
-format.docstring-code-format = true
-
-lint.select = [
-    "B",      # flake8-bugbear
-    "BLE",    # flake8-blind-except
-    "C4",     # flake8-comprehensions
-    "D",      # pydocstyle
-    "E",      # Error detected by Pycodestyle
-    "F",      # Errors detected by Pyflakes
-    "I",      # isort
-    "RUF100", # Report unused noqa directives
-    "TID",    # flake8-tidy-imports
-    "UP",     # pyupgrade
-    "W",      # Warning detected by Pycodestyle
-]
-lint.ignore = [
-    "B008", # Errors from function calls in argument defaults. These are fine when the result is immutable.
-    "D100", # Missing docstring in public module
-    "D104", # Missing docstring in public package
-    "D105", # __magic__ methods are often self-explanatory, allow missing docstrings
-    "D107", # Missing docstring in __init__
-    # Disable one in each pair of mutually incompatible rules
-    "D203", # We don’t want a blank line before a class docstring
-    "D213", # <> We want docstrings to start immediately after the opening triple quote
-    "D400", # first line should end with a period [Bug: doesn’t work with single-line docstrings]
-    "D401", # First line should be in imperative mood; try rephrasing
-    "E501", # line too long -> we accept long comment lines; formatter gets rid of long code lines
-    "E731", # Do not assign a lambda expression, use a def -> lambda expression assignments are convenient
-    "E741", # allow I, O, l as variable names -> I is the identity matrix
-    "I001",
-]
-
-[tool.pyproject-fmt]
-column_width = 120            # after how many column width split arrays/dicts into multiple lines, 1 will force always
-indent = 4
-keep_full_version = false     # if false will remove unnecessary trailing ``.0``'s from version specifiers
-max_supported_python = "3.13" # maximum Python version to use when generating version specifiers
-
-[tool.pytest.ini_options]
-# Pytest config
-minversion = "7.0"
-
-log_format = "%(asctime)s %(levelname)s %(message)s"
-log_date_format = "%Y-%m-%d %H:%M:%S"
-log_level = "INFO"
-log_cli = true
-
-python_files = "test_*.py"
-testpaths = [ "tests" ]
-
-xfail_strict = true
-addopts = [
-    "--import-mode=importlib", # allow using test files with same name
-]
-
-[tool.coverage.run]
-# Coverage config
-source = [ "matplotlib_sankey" ]
-omit = [ "*/tests/*" ]
-
-[tool.coverage.report]
-exclude_lines = [ "raise" ]
-ignore_errors = true
-
-[tool.coverage.html]
-directory = "docs/coverage_report"
-
-[tool.mypy]
-# Mypy config (https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file)
-python_version = "3.10"
-warn_return_any = true
-warn_unused_configs = true
-
-# Ignore libs which are not PEP 561 compliant
-# [[tool.mypy.overrides]]
-# module = [
-# ]
-# ignore_missing_imports = true

matplotlib_sankey-0.3.1/requirements.txt

@@ -1,133 +0,0 @@
-accessible-pygments==0.0.5
-alabaster==1.0.0
-astroid==3.3.9
-asttokens==3.0.0
-attrs==25.3.0
-babel==2.17.0
-backports.tarfile==1.2.0
-beautifulsoup4==4.13.4
-bleach==6.2.0
-certifi==2025.4.26
-cffi==1.17.1
-cfgv==3.4.0
-charset-normalizer==3.4.1
-comm==0.2.2
-contourpy==1.3.2
-coverage==7.8.0
-cryptography==44.0.2
-cycler==0.12.1
-debugpy==1.8.14
-decorator==5.2.1
-defusedxml==0.7.1
-distlib==0.3.9
-docutils==0.21.2
-exceptiongroup==1.2.2
-executing==2.2.0
-fastjsonschema==2.21.1
-filelock==3.18.0
-flit==3.12.0
-flit_core==3.12.0
-fonttools==4.57.0
-id==1.5.0
-identify==2.6.10
-idna==3.10
-imagesize==1.4.1
-importlib_metadata==8.6.1
-iniconfig==2.1.0
-ipykernel==6.29.5
-ipython==8.36.0
-ipywidgets==8.1.6
-jaraco.classes==3.4.0
-jaraco.context==6.0.1
-jaraco.functools==4.1.0
-jedi==0.19.2
-jeepney==0.9.0
-Jinja2==3.1.6
-jsonschema==4.23.0
-jsonschema-specifications==2025.4.1
-jupyter_client==8.6.3
-jupyter_core==5.7.2
-jupyterlab_pygments==0.3.0
-jupyterlab_widgets==3.0.14
-keyring==25.6.0
-kiwisolver==1.4.8
-markdown-it-py==3.0.0
-MarkupSafe==3.0.2
-matplotlib==3.10.3
-matplotlib-inline==0.1.7
-mdit-py-plugins==0.4.2
-mdurl==0.1.2
-mistune==3.1.3
-more-itertools==10.7.0
-mypy==1.15.0
-mypy_extensions==1.1.0
-myst-parser==4.0.1
-nbclient==0.10.2
-nbconvert==7.16.6
-nbformat==5.10.4
-nbsphinx==0.9.7
-nest-asyncio==1.6.0
-networkx==3.4.2
-nh3==0.2.21
-nodeenv==1.9.1
-numpy==2.2.5
-packaging==25.0
-pandas==2.2.3
-pandocfilters==1.5.1
-parso==0.8.4
-pexpect==4.9.0
-pillow==11.2.1
-platformdirs==4.3.7
-pluggy==1.5.0
-pre_commit==4.2.0
-prompt_toolkit==3.0.51
-psutil==7.0.0
-ptyprocess==0.7.0
-pure_eval==0.2.3
-pycparser==2.22
-pydata-sphinx-theme==0.15.4
-Pygments==2.19.1
-pyparsing==3.2.3
-pytest==8.3.5
-python-dateutil==2.9.0.post0
-pytz==2025.2
-PyYAML==6.0.2
-pyzmq==26.4.0
-readme_renderer==44.0
-referencing==0.36.2
-requests==2.32.3
-requests-toolbelt==1.0.0
-rfc3986==2.0.0
-rich==14.0.0
-rpds-py==0.24.0
-ruff==0.11.9
-scipy==1.15.2
-SecretStorage==3.3.3
-six==1.17.0
-snowballstemmer==2.2.0
-soupsieve==2.7
-Sphinx==8.1.3
-sphinx-autoapi==3.6.0
-sphinx-autodoc-typehints==3.0.1
-sphinx-book-theme==1.1.4
-sphinxcontrib-applehelp==2.0.0
-sphinxcontrib-devhelp==2.0.0
-sphinxcontrib-htmlhelp==2.1.0
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==2.0.0
-sphinxcontrib-serializinghtml==2.0.0
-stack-data==0.6.3
-tinycss2==1.4.0
-tomli==2.2.1
-tomli_w==1.2.0
-tornado==6.5
-traitlets==5.14.3
-twine==6.1.0
-typing_extensions==4.13.2
-tzdata==2025.2
-urllib3==2.4.0
-virtualenv==20.30.0
-wcwidth==0.2.13
-webencodings==0.5.1
-widgetsnbextension==4.0.14
-zipp==3.21.0

matplotlib_sankey-0.3.1/tests/test_colors.py

@@ -1,25 +0,0 @@
-from matplotlib_sankey._colors import is_color, is_colormap, colormap_to_list, is_hex_color, unify_color
-
-
-def test_color_utils() -> None:
-    """Testing color utils."""
-    assert all(
-        [
-            is_color("blue"),
-            is_color("tab:red"),
-            is_color("#3456ad"),
-            is_color([1, 0.4, 0.2]),
-            is_color([255, 60, 60]),
-        ]
-    )
-
-    assert is_hex_color("#345") is False
-    assert is_hex_color("test") is False
-    assert is_hex_color([255, 60, 60]) is False
-
-    assert unify_color("#FFFFFF") == (1, 1, 1)
-
-    assert is_colormap("tab10")
-    assert is_colormap("blue") is False
-
-    assert len(colormap_to_list("Reds", 20)) == 20

matplotlib_sankey-0.3.1/tests/test_sankey_plot.py

@@ -1,23 +0,0 @@
-import matplotlib.pyplot as plt
-from matplotlib_sankey import sankey
-
-
-def test_sankey_simple_plot():
-    """Testing simple sankey plot."""
-    data = [
-        [(0, 2, 20), (0, 1, 10), (3, 4, 15), (3, 2, 10), (5, 1, 5), (5, 2, 50)],
-        [(2, 6, 40), (1, 6, 15), (2, 7, 40), (4, 6, 15)],
-        [(7, 8, 5), (7, 9, 5), (7, 10, 20), (7, 11, 10), (6, 11, 55), (6, 8, 15)],
-    ]
-    sankey(data, frameon=True)
-    sankey(data, curve_type="curve3")
-    sankey(data, curve_type="line")
-    sankey(data, title="test", annotate_columns="index")
-    sankey(data, color="Reds", annotate_columns="weight")
-    sankey(data, color="tab:red", annotate_columns="weight_percent", annotate_columns_font_color="white")
-    sankey(data, color=["tab:red", "Reds", (0.1, 0.4, 1.0), "viridis"])
-    sankey(data, show_legend=True)
-    sankey(data, color="tab:red", column_labels=["A", "B", "C", "D"], show=False)
-
-    _, ax = plt.subplots()
-    sankey(data, ax=ax)

matplotlib_sankey-0.3.1/tests/test_utils.py

@@ -1,40 +0,0 @@
-from matplotlib import colormaps
-from matplotlib.colors import Colormap
-
-from matplotlib_sankey._utils import _generate_cmap, from_matrix, isinstance_list_of, is_light_color
-
-
-def test_utils_cmap() -> None:
-    """Testing utils function to generate cmap."""
-    assert isinstance(_generate_cmap("tab10", 4), Colormap)
-    assert isinstance(_generate_cmap("viridis", 4), Colormap)
-    assert _generate_cmap("viridis", 4).N == 4
-    assert isinstance(_generate_cmap(["#ec4899", "#0284c7", "#16a34a", "#f59e0b"], 4), Colormap)
-    assert isinstance(_generate_cmap([(0.4, 0.1, 0.9), (0.1, 0.1, 0.7)], 4), Colormap)
-    assert isinstance(_generate_cmap(colormaps["tab10"], 4), Colormap)
-
-
-def test_from_matrix() -> None:
-    """Testing from matrix helper function."""
-    assert len(from_matrix([[0, 0], [0, 0]])) == 0
-
-    assert len(from_matrix([[0, 0], [0, 0]], source_indicies=["A", "B"], target_indicies=["C", "D"])) == 0
-
-    assert len(from_matrix([[0, 1], [0, 0]])) == 1
-
-    assert len(from_matrix([[0, 1], [0, 1]], source_indicies=["A", "B"], target_indicies=["C", "D"])) == 2
-
-
-def test_isinstance_list_of() -> None:
-    """Testing is instance list of type."""
-    assert isinstance_list_of(["A", "b", "c"], str)
-    assert isinstance_list_of([1, 2, 3, 4], int)
-    assert isinstance_list_of(["A", "b", 1], str) is False
-    assert isinstance_list_of("test", str) is False
-
-
-def test_luminance() -> None:
-    """Testing is light color function."""
-    assert is_light_color((1, 1, 1)) is True
-    assert is_light_color((0, 0, 0)) is False
-    assert is_light_color((255, 255, 255), color_range_max=255) is True