bumplot 0.2.1__tar.gz → 0.3.0__tar.gz

bumplot-0.3.0/.github/workflows/doc.yaml

@@ -0,0 +1,32 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install the project
+        run: uv sync --all-groups
+
+      - run: uv run zensical build --clean
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./site

bumplot-0.3.0/.github/workflows/lint.yaml

@@ -0,0 +1,30 @@
+name: Check code formatting
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  check-formatting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install the project
+        run: uv sync --all-groups
+
+      - name: Run Ruff formatter and linter
+        run: |
+          uv run ruff format --check .
+          uv run ruff check

{bumplot-0.2.1 → bumplot-0.3.0}/.github/workflows/pypi.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
       - name: Set up Python

{bumplot-0.2.1 → bumplot-0.3.0}/.github/workflows/tests.yaml

@@ -11,11 +11,11 @@ jobs:
       matrix:
         python-version:
           - "3.10"
-          - "3.13"
+          - "3.15"
     env:
       UV_PYTHON: ${{ matrix.python-version }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5

{bumplot-0.2.1 → bumplot-0.3.0}/.github/workflows/type.yaml

@@ -1,9 +1,10 @@
-name: Check Static Typing
+name: Check static typing
 
 on:
+  push:
+    branches: [main]
   pull_request:
-    branches:
-      - main
+    branches: [main]
 
 jobs:
   check-formatting:
@@ -11,7 +12,9 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
@@ -21,5 +24,8 @@ jobs:
       - name: Install the project
         run: uv sync --all-groups
 
-      - name: Run tests
+      - name: ty
         run: uv run ty check
+
+      - name: pyrefly
+        run: uv run pyrefly check

{bumplot-0.2.1 → bumplot-0.3.0}/.gitignore

@@ -22,3 +22,5 @@ env/
 sandbox/
 release.sh
 .claude/
+
+site/

{bumplot-0.2.1 → bumplot-0.3.0}/PKG-INFO

@@ -1,17 +1,17 @@
 Metadata-Version: 2.4
 Name: bumplot
-Version: 0.2.1
+Version: 0.3.0
 Summary: Easily create and customize bump charts in Python
 Author-email: Joseph Barbier <joseph.barbierdarnal@gmail.com>
 License-Expression: MIT
+Project-URL: Documentation, https://y-sunflower.github.io/bumplot/
 Project-URL: Homepage, https://y-sunflower.github.io/bumplot/
 Project-URL: Issues, https://github.com/y-sunflower/bumplot/issues
-Project-URL: Documentation, https://y-sunflower.github.io/bumplot/
 Project-URL: Repository, https://github.com/y-sunflower/bumplot
-Keywords: bump,bump plot,bump charts,matplotlib,data,visualization,bezier,curve
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
+Keywords: bezier,bump,bump charts,bump plot,curve,data,matplotlib,visualization
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -21,20 +21,13 @@ Dynamic: license-file
 
 # `bumplot`: easily create and customize bump charts in Python
 
-<!-- Automatically generated, uses README.qmd to modify README.md -->
-
 <img src="https://github.com/JosephBARBIERDARNAL/static/blob/main/python-libs/bumplot/image.png?raw=true" alt="bumplot logo" align="right" width="180px"/>
 
-`bumplot` is a small Python package made to facilitate the creation of
-**bump charts** using matplotlib and Bézier curves. It has high
-customization capabilities too!
+`bumplot` is a small Python package made to facilitate the creation of **bump charts** using matplotlib and Bézier curves. It has high customization capabilities too!
 
-Bump charts are useful when the focus is on comparing **relative
-rankings**—who is ahead of whom—rather than the exact magnitude of the
-differences.
+Bump charts are useful when the focus is on comparing **relative rankings**—who is ahead of whom—rather than the exact magnitude of the differences.
 
-Check out the [online
-documentation](https://y-sunflower.github.io/bumplot/)
+Check out the [online documentation](https://y-sunflower.github.io/bumplot/)
 
 <br> <br>
 
@@ -70,7 +63,7 @@ ax.spines[["top", "right", "left", "bottom"]].set_visible(False)
 ax.grid(alpha=0.4)
 ```
 
-![](README_files/figure-commonmark/cell-3-output-1.png)
+![A simple bump chart made with Python and bumplot](example.png)
 
 [See more examples](https://y-sunflower.github.io/bumplot/examples/)
 
@@ -78,14 +71,15 @@ ax.grid(alpha=0.4)
 
 ## Installation
 
-    pip install bumplot
+```sh
+pip install bumplot
+```
 
 <br><br>
 
 ## Features
 
-- Automatic ranking of your data (with support for both `pandas` and
-  `polars`)
+- Automatic ranking of your data (with support for both `pandas` and `polars`)
 - Accept categorical data for x-axis
 - Infinite customization capabilities
 - Easy control of the curvature intensity

bumplot-0.2.1/docs/index.md → bumplot-0.3.0/README.md

@@ -6,13 +6,13 @@
 
 Bump charts are useful when the focus is on comparing **relative rankings**—who is ahead of whom—rather than the exact magnitude of the differences.
 
-<br>
-<br>
+Check out the [online documentation](https://y-sunflower.github.io/bumplot/)
 
-## Quick start
+<br> <br>
+
+## Get started
 
 ```python
-# mkdocs: render
 import matplotlib.pyplot as plt
 import pandas as pd
 
@@ -42,19 +42,23 @@ ax.spines[["top", "right", "left", "bottom"]].set_visible(False)
 ax.grid(alpha=0.4)
 ```
 
-[See more examples](./examples.md)
+![A simple bump chart made with Python and bumplot](example.png)
+
+[See more examples](https://y-sunflower.github.io/bumplot/examples/)
+
+<br> <br>
 
 ## Installation
 
-```
+```sh
 pip install bumplot
 ```
 
+<br><br>
+
 ## Features
 
 - Automatic ranking of your data (with support for both `pandas` and `polars`)
 - Accept categorical data for x-axis
 - Infinite customization capabilities
 - Easy control of the curvature intensity
-
-<br>

bumplot-0.3.0/bumplot/__init__.py

@@ -0,0 +1,5 @@
+from bumplot.main import bumplot
+from bumplot.opts import opts, opts_from_color
+
+__version__ = "0.3.0"
+__all__ = ["bumplot", "opts", "opts_from_color"]

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot/_utils.py

@@ -1,8 +1,11 @@
+from typing import Any
+
 import narwhals as nw
+from narwhals import DataFrame
 from narwhals.typing import IntoDataFrame
 
 
-def _ranked_df(df: IntoDataFrame, x: str, y_columns: list[str]):
+def _ranked_df(df: IntoDataFrame, x: str, y_columns: list[str]) -> DataFrame[Any]:
     """
     Convert a dataframe to a ranked version of it.
     """

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot/bezier.py

@@ -1,5 +1,5 @@
-from matplotlib.path import Path
 import numpy as np
+from matplotlib.path import Path
 
 
 def bezier_curve(
@@ -25,18 +25,24 @@ def bezier_curve(
         vertices: List of (x, y) vertices including control points for the Bézier segments.
         codes: Corresponding matplotlib Path codes for constructing the curve.
     """
-    vertices: list = []
-    codes: list = []
+    vertices = []
+    codes = []
 
-    vertices.append((x[0], y[0]))
-    codes.append(Path.MOVETO)
+    vertices.append((float(x[0]), float(y[0])))
+    codes.append(int(Path.MOVETO))
 
     for i in range(1, len(x)):
         x0, y0 = x[i - 1], y[i - 1]
         x1, y1 = x[i], y[i]
         dx = (x1 - x0) * force
 
-        vertices.extend([(x0 + dx, y0), (x1 - dx, y1), (x1, y1)])
-        codes.extend([Path.CURVE4, Path.CURVE4, Path.CURVE4])
+        vertices.extend(
+            [
+                (float(x0 + dx), float(y0)),
+                (float(x1 - dx), float(y1)),
+                (float(x1), float(y1)),
+            ]
+        )
+        codes.extend([int(Path.CURVE4)] * 3)
 
     return vertices, codes

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot/main.py

@@ -1,24 +1,21 @@
-from collections import ChainMap
+from collections.abc import Iterable
 from itertools import cycle
+from typing import Any
 
 import matplotlib.pyplot as plt
+import numpy as np
+from matplotlib import patches
 from matplotlib.axes import Axes
-from matplotlib.path import Path
-import matplotlib.patches as patches
 from matplotlib.cbook import normalize_kwargs
 from matplotlib.collections import PathCollection
 from matplotlib.patches import PathPatch
-
-import numpy as np
-
+from matplotlib.path import Path
 from narwhals.typing import IntoDataFrame
 
-from .bezier import bezier_curve
 from ._utils import _ranked_df, _to_ordinal
+from .bezier import bezier_curve
 from .opts import BumpOpts, _get_plot_kwargs, _get_scatter_kwargs
 
-from typing import Any, Iterable, Tuple
-
 
 def bumplot(
     x: str,
@@ -27,11 +24,11 @@ def bumplot(
     curve_force: float = 1,
     invert_y_axis: bool = True,
     colors: Iterable[str] | None = None,
-    plot_kwargs: dict[str, Any] = {},
-    scatter_kwargs: dict[str, Any] = {},
+    plot_kwargs: dict[str, Any] | None = None,
+    scatter_kwargs: dict[str, Any] | None = None,
     ax: Axes | None = None,
     ordinal_labels: bool = False,
-) -> Tuple[Axes, dict[str, Tuple[PathPatch, PathCollection]]]:
+) -> tuple[Axes, dict[str, tuple[PathPatch, PathCollection]]]:
     """
     Creates bump plot, or bump chart, from multiple numerical
     columns.
@@ -55,6 +52,8 @@ def bumplot(
     Returns:
         The matplotlib Axes with the bump plot
     """
+    plot_kwargs = {} if plot_kwargs is None else plot_kwargs
+    scatter_kwargs = {} if scatter_kwargs is None else scatter_kwargs
     _plot_ax: Axes = ax if ax is not None else plt.gca()
     colors_iterable = (
         colors
@@ -65,7 +64,7 @@ def bumplot(
     y_bumps: list[tuple[str, BumpOpts]] = [
         (y, BumpOpts()) if isinstance(y, str) else y for y in y_columns
     ]
-    ranked: IntoDataFrame = _ranked_df(data, x=x, y_columns=[y for y, _ in y_bumps])
+    ranked = _ranked_df(data, x=x, y_columns=[y for y, _ in y_bumps])
     x_values_raw: np.ndarray = np.ravel(ranked.select(x).to_numpy())
 
     if np.issubdtype(x_values_raw.dtype, np.number):
@@ -87,26 +86,20 @@ def bumplot(
         )
 
         path: Path = Path(vertices=vertices, codes=codes)
-        patch: PathPatch = patches.PathPatch(
-            path=path,
-            facecolor="none",
-            **ChainMap(
-                _get_plot_kwargs(bump_opts),
-                normalize_kwargs(plot_kwargs, PathPatch),
-                {"edgecolor": color},
-            ),
-        )
+        path_kwargs: dict[str, Any] = {"edgecolor": color}
+        path_kwargs.update(normalize_kwargs(plot_kwargs, PathPatch))
+        path_kwargs.update(_get_plot_kwargs(bump_opts))
+        patch: PathPatch = patches.PathPatch(path=path, facecolor="none", **path_kwargs)
         _plot_ax.add_patch(patch)
 
+        artist_scatter_kwargs: dict[str, Any] = {"facecolor": color}
+        artist_scatter_kwargs.update(normalize_kwargs(scatter_kwargs, PathCollection))
+        artist_scatter_kwargs.update(_get_scatter_kwargs(bump_opts))
         scatter = _plot_ax.scatter(
             x_values,
             y_values,
             label=name,
-            **ChainMap(
-                _get_scatter_kwargs(bump_opts),
-                normalize_kwargs(scatter_kwargs, PathCollection),
-                {"facecolor": color},
-            ),
+            **artist_scatter_kwargs,
         )
         artists[name] = (patch, scatter)
 

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot/opts.py

@@ -1,4 +1,5 @@
-from typing import Any, TypedDict
+from collections.abc import Mapping
+from typing import Any, TypedDict, cast
 
 
 class BumpOpts(TypedDict, total=False):
@@ -151,12 +152,11 @@ def _get_plot_kwargs(kwargs: BumpOpts, /) -> dict[str, Any]:
     -----
     - Only keys present in both `kwargs` and `PLOT_MAPPINGS` are included.
     """
-    plot_kwargs = {}
+    kwargs_mapping = cast(Mapping[str, Any], kwargs)
+    plot_kwargs: dict[str, Any] = {}
     for bump_arg, mpl_arg in PLOT_MAPPINGS.items():
-        try:
-            plot_kwargs[mpl_arg] = kwargs[bump_arg]  # type: ignore[invalid-key]
-        except KeyError:
-            pass
+        if bump_arg in kwargs_mapping:
+            plot_kwargs[mpl_arg] = kwargs_mapping[bump_arg]
     return plot_kwargs
 
 
@@ -182,10 +182,9 @@ def _get_scatter_kwargs(kwargs: BumpOpts, /) -> dict[str, Any]:
     -----
     - Only keys present in both `kwargs` and `SCATTER_MAPPINGS` are included.
     """
-    scatter_kwargs = {}
+    kwargs_mapping = cast(Mapping[str, Any], kwargs)
+    scatter_kwargs: dict[str, Any] = {}
     for bump_arg, mpl_arg in SCATTER_MAPPINGS.items():
-        try:
-            scatter_kwargs[mpl_arg] = kwargs[bump_arg]  # type: ignore[invalid-key]
-        except KeyError:
-            pass
+        if bump_arg in kwargs_mapping:
+            scatter_kwargs[mpl_arg] = kwargs_mapping[bump_arg]
     return scatter_kwargs

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot.egg-info/PKG-INFO

@@ -1,17 +1,17 @@
 Metadata-Version: 2.4
 Name: bumplot
-Version: 0.2.1
+Version: 0.3.0
 Summary: Easily create and customize bump charts in Python
 Author-email: Joseph Barbier <joseph.barbierdarnal@gmail.com>
 License-Expression: MIT
+Project-URL: Documentation, https://y-sunflower.github.io/bumplot/
 Project-URL: Homepage, https://y-sunflower.github.io/bumplot/
 Project-URL: Issues, https://github.com/y-sunflower/bumplot/issues
-Project-URL: Documentation, https://y-sunflower.github.io/bumplot/
 Project-URL: Repository, https://github.com/y-sunflower/bumplot
-Keywords: bump,bump plot,bump charts,matplotlib,data,visualization,bezier,curve
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
+Keywords: bezier,bump,bump charts,bump plot,curve,data,matplotlib,visualization
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -21,20 +21,13 @@ Dynamic: license-file
 
 # `bumplot`: easily create and customize bump charts in Python
 
-<!-- Automatically generated, uses README.qmd to modify README.md -->
-
 <img src="https://github.com/JosephBARBIERDARNAL/static/blob/main/python-libs/bumplot/image.png?raw=true" alt="bumplot logo" align="right" width="180px"/>
 
-`bumplot` is a small Python package made to facilitate the creation of
-**bump charts** using matplotlib and Bézier curves. It has high
-customization capabilities too!
+`bumplot` is a small Python package made to facilitate the creation of **bump charts** using matplotlib and Bézier curves. It has high customization capabilities too!
 
-Bump charts are useful when the focus is on comparing **relative
-rankings**—who is ahead of whom—rather than the exact magnitude of the
-differences.
+Bump charts are useful when the focus is on comparing **relative rankings**—who is ahead of whom—rather than the exact magnitude of the differences.
 
-Check out the [online
-documentation](https://y-sunflower.github.io/bumplot/)
+Check out the [online documentation](https://y-sunflower.github.io/bumplot/)
 
 <br> <br>
 
@@ -70,7 +63,7 @@ ax.spines[["top", "right", "left", "bottom"]].set_visible(False)
 ax.grid(alpha=0.4)
 ```
 
-![](README_files/figure-commonmark/cell-3-output-1.png)
+![A simple bump chart made with Python and bumplot](example.png)
 
 [See more examples](https://y-sunflower.github.io/bumplot/examples/)
 
@@ -78,14 +71,15 @@ ax.grid(alpha=0.4)
 
 ## Installation
 
-    pip install bumplot
+```sh
+pip install bumplot
+```
 
 <br><br>
 
 ## Features
 
-- Automatic ranking of your data (with support for both `pandas` and
-  `polars`)
+- Automatic ranking of your data (with support for both `pandas` and `polars`)
 - Accept categorical data for x-axis
 - Infinite customization capabilities
 - Easy control of the curvature intensity

{bumplot-0.2.1 → bumplot-0.3.0}/bumplot.egg-info/SOURCES.txt

@@ -4,15 +4,15 @@
 LICENSE
 README.md
 coverage-badge.svg
+example.png
 justfile
-mkdocs.yaml
 pyproject.toml
+zensical.toml
 .github/workflows/doc.yaml
 .github/workflows/lint.yaml
 .github/workflows/pypi.yaml
 .github/workflows/tests.yaml
 .github/workflows/type.yaml
-README_files/figure-commonmark/cell-3-output-1.png
 bumplot/__init__.py
 bumplot/_utils.py
 bumplot/bezier.py
@@ -24,7 +24,6 @@ bumplot.egg-info/dependency_links.txt
 bumplot.egg-info/requires.txt
 bumplot.egg-info/top_level.txt
 docs/.gitignore
-docs/README.qmd
 docs/advanced-usage.md
 docs/contributing.md
 docs/examples.md
@@ -33,7 +32,6 @@ docs/data/water-africa.csv
 docs/reference/bezier.md
 docs/reference/bumplot.md
 docs/stylesheets/style.css
-overrides/partials/footer.html
 tests/__init__.py
 tests/test_main.py
 tests/test_opts.py

{bumplot-0.2.1 → bumplot-0.3.0}/docs/advanced-usage.md

@@ -9,9 +9,10 @@ These examples are also designed to be easy to reproduce: you should be able to
 
 ## Water sources in Africa
 
-```py
-# mkdocs: render
+```python exec="on" source="above" html="true"
 import pandas as pd
+import matplotlib  # markdown-exec: hide
+matplotlib.use("Agg")  # markdown-exec: hide
 import matplotlib.pyplot as plt
 from pyfonts import set_default_font, load_google_font
 
@@ -36,7 +37,7 @@ _, bump_artists = bumplot(
     data=df,
     curve_force=0.7,
     ordinal_labels=True,
-    colors=["lightgray"]
+    colors=["lightgray"],
 )
 ax.spines[["top", "right", "left", "bottom"]].set_visible(False)
 ax.margins(x=0.01)
@@ -87,6 +88,13 @@ fig.text(
     font=load_google_font("Poppins", italic=True),
     size=10,
 )
+from base64 import b64encode  # markdown-exec: hide
+from io import BytesIO  # markdown-exec: hide
+
+buffer = BytesIO()  # markdown-exec: hide
+fig.savefig(buffer, format="png")  # markdown-exec: hide
+print('<img alt="Rendered plot" src="data:image/png;base64,{}">'.format(b64encode(buffer.getvalue()).decode()))  # markdown-exec: hide
+plt.close(fig)  # markdown-exec: hide
 ```
 
 <br>
@@ -94,9 +102,10 @@ fig.text(
 
 ## Global CO₂ Emissions Rankings
 
-```py
-# mkdocs: render
+```python exec="on" source="above" html="true"
 import pandas as pd
+import matplotlib  # markdown-exec: hide
+matplotlib.use("Agg")  # markdown-exec: hide
 import matplotlib.pyplot as plt
 from pyfonts import set_default_font, load_google_font
 
@@ -228,4 +237,11 @@ fig.text(
     font=font_bold,
     size=8,
 )
+from base64 import b64encode  # markdown-exec: hide
+from io import BytesIO  # markdown-exec: hide
+
+buffer = BytesIO()  # markdown-exec: hide
+fig.savefig(buffer, format="png")  # markdown-exec: hide
+print('<img alt="Rendered plot" src="data:image/png;base64,{}">'.format(b64encode(buffer.getvalue()).decode()))  # markdown-exec: hide
+plt.close(fig)  # markdown-exec: hide
 ```