labplotlib 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

labplotlib/__init__.py

@@ -1,3 +1,17 @@
-from .Symbols import print_symbols, search, symbols
+from .plots import errorbar_plot, line_plot, scatter_with_fit
+from .styling import apply_theme, finish_plot, style_axis
+from .symbols import print_symbols, search, symbols
 
-__all__ = ["symbols", "search", "print_symbols"]
+__version__ = "0.2.0"
+
+__all__ = [
+    "apply_theme",
+    "errorbar_plot",
+    "finish_plot",
+    "line_plot",
+    "print_symbols",
+    "scatter_with_fit",
+    "search",
+    "style_axis",
+    "symbols",
+]

labplotlib/plots.py

@@ -0,0 +1,81 @@
+from typing import Optional, Sequence
+
+import numpy as np
+from matplotlib import pyplot as plt
+from matplotlib.figure import Figure
+
+from .styling import PathLike, apply_theme, finish_plot, style_axis
+
+
+def _new_figure(figsize):
+    apply_theme()
+    return plt.subplots(figsize=figsize)
+
+
+def line_plot(
+    x: Sequence[float],
+    y: Sequence[float],
+    title: Optional[str] = None,
+    xlabel: Optional[str] = None,
+    ylabel: Optional[str] = None,
+    filename: Optional[str] = None,
+    save_directory: Optional[PathLike] = None,
+    show: bool = True,
+    figsize=(8, 5),
+) -> Figure:
+    """Plot ``y`` against ``x`` as a line and return the figure."""
+    fig, ax = _new_figure(figsize)
+    ax.plot(x, y)
+    style_axis(ax, title, xlabel, ylabel)
+    return finish_plot(fig, filename, save_directory, show)
+
+
+def scatter_with_fit(
+    x: Sequence[float],
+    y: Sequence[float],
+    degree: int = 1,
+    title: Optional[str] = None,
+    xlabel: Optional[str] = None,
+    ylabel: Optional[str] = None,
+    filename: Optional[str] = None,
+    save_directory: Optional[PathLike] = None,
+    show: bool = True,
+    figsize=(8, 5),
+) -> Figure:
+    """Scatter the data with a least-squares polynomial fit of ``degree``."""
+    x_values = np.asarray(x, dtype=float)
+    y_values = np.asarray(y, dtype=float)
+    if x_values.shape != y_values.shape:
+        raise ValueError("x and y must have the same shape")
+    if degree < 1 or x_values.size <= degree:
+        raise ValueError("degree must be >= 1 and less than the number of points")
+
+    coefficients = np.polyfit(x_values, y_values, degree)
+    fit_x = np.linspace(x_values.min(), x_values.max(), 200)
+
+    fig, ax = _new_figure(figsize)
+    ax.scatter(x_values, y_values, label="data")
+    ax.plot(fit_x, np.polyval(coefficients, fit_x), color="C1", label=f"fit (degree {degree})")
+    ax.legend()
+    style_axis(ax, title, xlabel, ylabel)
+    return finish_plot(fig, filename, save_directory, show)
+
+
+def errorbar_plot(
+    x: Sequence[float],
+    y: Sequence[float],
+    yerr: Optional[Sequence[float]] = None,
+    xerr: Optional[Sequence[float]] = None,
+    title: Optional[str] = None,
+    xlabel: Optional[str] = None,
+    ylabel: Optional[str] = None,
+    filename: Optional[str] = None,
+    save_directory: Optional[PathLike] = None,
+    show: bool = True,
+    figsize=(8, 5),
+) -> Figure:
+    """Plot ``y`` against ``x`` with optional error bars."""
+    fig, ax = _new_figure(figsize)
+    ax.errorbar(x, y, yerr=yerr, xerr=xerr, fmt="o", capsize=3)
+    style_axis(ax, title, xlabel, ylabel)
+    return finish_plot(fig, filename, save_directory, show)

labplotlib/styling.py

@@ -0,0 +1,46 @@
+from pathlib import Path
+from typing import Optional, Union
+
+import seaborn as sns
+from matplotlib import pyplot as plt
+from matplotlib.axes import Axes
+from matplotlib.figure import Figure
+
+PathLike = Union[str, Path]
+
+
+def apply_theme() -> None:
+    """Apply the library's Seaborn theme globally."""
+    sns.set_theme(style="darkgrid", rc={"axes.facecolor": ".9"})
+
+
+def style_axis(
+    ax: Axes,
+    title: Optional[str] = None,
+    xlabel: Optional[str] = None,
+    ylabel: Optional[str] = None,
+) -> None:
+    """Set a bold title and axis labels on ``ax``."""
+    ax.set(xlabel=xlabel, ylabel=ylabel)
+    if title:
+        ax.set_title(title, fontdict={"fontsize": 14, "fontweight": "bold"})
+
+
+def finish_plot(
+    fig: Figure,
+    filename: Optional[str] = None,
+    save_directory: Optional[PathLike] = None,
+    show: bool = True,
+) -> Figure:
+    """
+    Tidy the layout, optionally save the figure, optionally show it,
+    and return it. The save directory is created if it does not exist.
+    """
+    fig.tight_layout()
+    if filename is not None:
+        directory = Path(save_directory) if save_directory is not None else Path.cwd()
+        directory.mkdir(parents=True, exist_ok=True)
+        fig.savefig(directory / filename)
+    if show:
+        plt.show()
+    return fig

labplotlib/{Symbols.py → symbols.py}

@@ -1,4 +1,5 @@
 from types import MappingProxyType
+from typing import Mapping
 
 symbols = MappingProxyType(
     {
@@ -13,7 +14,7 @@ symbols = MappingProxyType(
         "set_is_superset_of": "⊇",
         "set_is_proper_superset_of": "⊃",
         "set_is_not_superset_of": "⊅",
-        "set_universal": "ξ",
+        "set_universal": "𝕌",
         "set_minus": "∖",
         "set_cartesian_product": "×",
         "set_difference": "\\",
@@ -75,7 +76,7 @@ symbols = MappingProxyType(
         "degree_celsius": "°C",
         "degree_fahrenheit": "°F",
         "diameter": "⌀",
-        "multiplication": "✕",
+        "multiplication": "×",
         "division": "÷",
         "left_floor": "⌊",
         "right_floor": "⌋",
@@ -91,7 +92,7 @@ symbols = MappingProxyType(
         "top_half_integral": "⌠",
         "bottom_half_integral": "⌡",
         "not_sign": "¬",
-        "+/-": "±",
+        "plus_minus": "±",
         "square_root": "√",
         "cube_root": "∛",
         "fourth_root": "∜",
@@ -100,7 +101,8 @@ symbols = MappingProxyType(
         "right_angle": "∟",
         "angle": "∠",
         "therefore": "∴",
-        "approximately_equal_to": "≅",
+        "approximately_equal_to": "≈",
+        "congruent_to": "≅",
         "not_equal_to": "≠",
         "less_than_or_equal_to": "≤",
         "greater_than_or_equal_to": "≥",
@@ -112,31 +114,30 @@ symbols = MappingProxyType(
 )
 
 
-def search(namelike: str) -> MappingProxyType:
-
+def search(namelike: str) -> Mapping[str, str]:
+    """
+    Return a read-only mapping of the symbols whose names contain
+    ``namelike``. The match is case-insensitive.
     """
-    Return a dictionary of symbols with names
-    containing namelike argument
-    """    
 
-    filtered = {k: v for k, v in symbols.items() if namelike in k}
+    needle = namelike.lower()
+    filtered = {k: v for k, v in symbols.items() if needle in k.lower()}
 
     return MappingProxyType(filtered)
 
 
-def print_symbols(symbols_to_print:MappingProxyType = symbols) -> None:
+def _hex_escape(char: str) -> str:
+    code = ord(char)
+    return f"\\u{code:04x}" if code <= 0xFFFF else f"\\U{code:08x}"
 
+
+def print_symbols(symbols_to_print: Mapping[str, str] = symbols) -> None:
     """
-    Prints symbols in the symbols argument,
-    or all if this is omitted
+    Print the symbols in ``symbols_to_print`` (all symbols by default)
+    with their decimal and hexadecimal code points.
     """
 
-    for symbol in symbols_to_print.keys():
-
-        print(f"{symbol.ljust(32, ' ')}", end="")
-
-        print(f" {symbols_to_print[symbol]}", end="")
-
-        print(f"   decimal: {str(ord(symbols_to_print[symbol])).ljust(5, ' ')}", end="")
-
-        print(f"   hexadecimal: \\u{hex(ord(symbols_to_print[symbol]))[2:]}")
+    for name, value in symbols_to_print.items():
+        decimal = " ".join(str(ord(c)) for c in value)
+        hexadecimal = " ".join(_hex_escape(c) for c in value)
+        print(f"{name:<32} {value}   decimal: {decimal:<8}   hexadecimal: {hexadecimal}")

labplotlib-0.2.0.dist-info/METADATA

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: labplotlib
+Version: 0.2.0
+Summary: Plot styling helpers and searchable mathematical symbols.
+Author: iancullinane06
+License: MIT
+Project-URL: Homepage, https://github.com/iancullinane06/LabPlotLib
+Project-URL: Issues, https://github.com/iancullinane06/LabPlotLib/issues
+Project-URL: Changelog, https://github.com/iancullinane06/LabPlotLib/blob/main/CHANGELOG.md
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: numpy>=1.21
+Requires-Dist: seaborn>=0.11.2
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# LabPlotLib
+
+LabPlotLib is a small Python library containing plotting-style helpers and a
+searchable collection of mathematical symbols.
+
+## Installation
+
+Install the latest source checkout with pip:
+
+```powershell
+python -m pip install .
+```
+
+For development, install it in editable mode:
+
+```powershell
+python -m pip install -e .
+```
+
+## Symbol utilities
+
+```python
+from labplotlib import print_symbols, search, symbols
+
+print(symbols["set_union"])
+print(search("fraction"))
+print_symbols(search("fraction_one"))
+```
+
+The `symbols` mapping is read-only. `search(name_part)` returns a read-only
+mapping of symbol names containing `name_part` (case-insensitive).
+
+## Plotting
+
+```python
+from labplotlib import errorbar_plot, line_plot, scatter_with_fit
+
+line_plot([1, 2, 3], [1, 4, 9], title="Squares", xlabel="x", ylabel="y")
+scatter_with_fit(x, y, degree=1, filename="fit.png", save_directory="plots")
+errorbar_plot(x, y, yerr=err, show=False)  # returns the matplotlib Figure
+```
+
+Each function returns the `Figure`. Pass `filename` (and optionally
+`save_directory`, created if missing) to save, and `show=False` to skip
+`plt.show()`. Importing the package does not change global matplotlib
+settings; the plot functions apply the Seaborn theme via `apply_theme()`, which
+you can also call yourself. Lower-level helpers `style_axis` and `finish_plot`
+are public too.
+
+## Development
+
+```powershell
+python -m pip install -e ".[dev]"
+ruff check .
+python -m unittest discover -s tests
+```
+
+The version lives in `src/labplotlib/__init__.py`; see
+[CHANGELOG.md](CHANGELOG.md) for release notes.
+
+## Publishing
+
+Publishing is automated when a GitHub Release is published. Configure a PyPI
+trusted publisher for this repository with:
+
+- Owner and repository: the values for this GitHub project
+- Workflow: `.github/workflows/publish.yml`
+- Environment: `pypi`
+
+Then update the version in `pyproject.toml`, push the change, and create a
+GitHub Release with a matching version tag (for example, `v0.1.1`). The
+workflow runs the tests, builds the distributions, and publishes them without
+requiring a PyPI API token in GitHub secrets.

labplotlib-0.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+labplotlib/__init__.py,sha256=xk7cm4ukpfIh6wpC4NhlkxFamkKMcJnnEzzyL_8b3gk,395
+labplotlib/plots.py,sha256=IoRHCPwZEIC7rz70kxz8eUF-jg2R9MFcHRcbO94jZWE,2701
+labplotlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+labplotlib/styling.py,sha256=6VOduEAhnynZ7W3zu4JZvyzD_4rYFOih84na0Rbx5xs,1333
+labplotlib/symbols.py,sha256=0s8CuEoK6V7vL3CZztfzA4V8YxYTMYhBlwpaRvq24VM,4916
+labplotlib-0.2.0.dist-info/licenses/LICENSE,sha256=qtD8JTBOufwHP-9RzB6ONro1LXlcdx-w6Xwk8-1zk28,1092
+labplotlib-0.2.0.dist-info/METADATA,sha256=815QUev1vwGyctyyw1FulrZHbP5RaIamjREs0J4iwH4,3117
+labplotlib-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+labplotlib-0.2.0.dist-info/top_level.txt,sha256=n1nselG8yl820GQWj11wPJIjWlToFxTfK2nIOc1x7VU,11
+labplotlib-0.2.0.dist-info/RECORD,,

labplotlib-0.2.0.dist-info/licenses/LICENSE

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

labplotlib/Styling.py

@@ -1,20 +0,0 @@
-import seaborn as sns
-from matplotlib import pyplot as plt    
-
-sns.set_theme(style="darkgrid", rc={"axes.facecolor": ".9"})
-
-def _style_axis(ax, title, xlabel, ylabel):
-    ax.set(
-        xlabel=xlabel,
-        ylabel=ylabel
-    )
-    ax.set_title(title, fontdict={"fontsize": 14, "fontweight": "bold"})
-
-
-def _finish_plot(fig, filename, save_directory):
-    fig.tight_layout()
-    fig.savefig(f"{save_directory}/{filename}")
-    plt.show()
-    
-if __name__ == "__main__":
-    pass

labplotlib-0.1.0.dist-info/METADATA

@@ -1,58 +0,0 @@
-Metadata-Version: 2.4
-Name: labplotlib
-Version: 0.1.0
-Summary: Plot styling helpers and searchable mathematical symbols.
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: matplotlib>=3.5
-Requires-Dist: seaborn>=0.11.2
-
-# LabPlotLib
-
-LabPlotLib is a small Python library containing plotting-style helpers and a
-searchable collection of mathematical symbols.
-
-## Installation
-
-Install the latest source checkout with pip:
-
-```powershell
-python -m pip install .
-```
-
-For development, install it in editable mode:
-
-```powershell
-python -m pip install -e .
-```
-
-## Symbol utilities
-
-```python
-from labplotlib import print_symbols, search, symbols
-
-print(symbols["set_union"])
-print(search("fraction"))
-print_symbols(search("fraction_one"))
-```
-
-The `symbols` mapping is read-only. `search(name_part)` returns a read-only
-mapping containing symbol names that include `name_part`.
-
-Importing `labplotlib.Styling` applies the library's Seaborn plotting theme.
-
-## Publishing
-
-Publishing is automated when a GitHub Release is published. Configure a PyPI
-trusted publisher for this repository with:
-
-- Owner and repository: the values for this GitHub project
-- Workflow: `.github/workflows/publish.yml`
-- Environment: `pypi`
-
-Then update the version in `pyproject.toml`, push the change, and create a
-GitHub Release with a matching version tag (for example, `v0.1.1`). The
-workflow runs the tests, builds the distributions, and publishes them without
-requiring a PyPI API token in GitHub secrets.

labplotlib-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-labplotlib/Styling.py,sha256=EV1R6gRcERnbtpuyA9XVucI-4sYmaJl4pd2c-mVJ6i0,502
-labplotlib/Symbols.py,sha256=iQVXY3NPSqq0tVEp7o1mHROvIkBrNeXcT4ECC9l6SoY,4667
-labplotlib/__init__.py,sha256=nkMH8auQivc9vbjZaFyAsZ5rM_Jqisl4PxTsxAZeYe0,105
-labplotlib-0.1.0.dist-info/METADATA,sha256=QfPmJPPBPFx-SE0qwlGCr_XW_5a2MWwh-AX6ud2yKAE,1668
-labplotlib-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-labplotlib-0.1.0.dist-info/top_level.txt,sha256=n1nselG8yl820GQWj11wPJIjWlToFxTfK2nIOc1x7VU,11
-labplotlib-0.1.0.dist-info/RECORD,,