TypedUnit 0.2.10__tar.gz → 0.2.14__tar.gz

typedunit-0.2.10/.github/workflows/deploy_anaconda.yml → typedunit-0.2.14/.github/workflows/deploy_release.yml

@@ -1,4 +1,4 @@
-name: Publish Conda package
+name: Publish release
 
 on:
   push:
@@ -8,10 +8,19 @@ permissions:
   contents: read
 
 jobs:
-  publish:
+  pypi:
+    name: Publish to PyPI
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@a01969bc5af90666281f9d37acffdf6a4629763a
+    with:
+      python-version: "3.11"
+      test-command: python -c 'import TypedUnit; print(TypedUnit.__version__)'
+    secrets:
+      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+
+  conda:
+    name: Publish Conda package
     uses: MartinPdeS/MPSActions/.github/workflows/publish_compiled_package_to_anaconda.yml@a01969bc5af90666281f9d37acffdf6a4629763a
     with:
-      # One noarch archive supports all declared Python versions; test it on 3.14.
       python_versions: '["3.14"]'
       os_list: '["ubuntu-latest"]'
       package_name: typedunit

{typedunit-0.2.10 → typedunit-0.2.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.2.10
+Version: 0.2.14
 Summary: A package wrapping pint for handling typed units in Python.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -53,7 +53,7 @@ Requires-Dist: pytest-json-report~=1.5; extra == "testing"
 Requires-Dist: flake8==7.3.0; extra == "testing"
 Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
-Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
+Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "documentation"
 Requires-Dist: numpydoc~=1.8; extra == "documentation"
 Requires-Dist: sphinx>=6; extra == "documentation"
 Requires-Dist: sphinx-gallery~=0.17; extra == "documentation"

{typedunit-0.2.10 → typedunit-0.2.14}/TypedUnit/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.10'
-__version_tuple__ = version_tuple = (0, 2, 10)
+__version__ = version = '0.2.14'
+__version_tuple__ = version_tuple = (0, 2, 14)
 
-__commit_id__ = commit_id = 'g156c1ff07'
+__commit_id__ = commit_id = 'g71aab5d79'

{typedunit-0.2.10 → typedunit-0.2.14}/TypedUnit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypedUnit
-Version: 0.2.10
+Version: 0.2.14
 Summary: A package wrapping pint for handling typed units in Python.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -53,7 +53,7 @@ Requires-Dist: pytest-json-report~=1.5; extra == "testing"
 Requires-Dist: flake8==7.3.0; extra == "testing"
 Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
-Requires-Dist: MartinPdeS-docs<0.2,>=0.1.4; extra == "documentation"
+Requires-Dist: MartinPdeS-docs<0.3,>=0.2.1; extra == "documentation"
 Requires-Dist: numpydoc~=1.8; extra == "documentation"
 Requires-Dist: sphinx>=6; extra == "documentation"
 Requires-Dist: sphinx-gallery~=0.17; extra == "documentation"

{typedunit-0.2.10 → typedunit-0.2.14}/TypedUnit.egg-info/SOURCES.txt

@@ -9,10 +9,9 @@ README.rst
 pyproject.toml
 pytest.ini
 .github/dependabot.yml
-.github/workflows/deploy_PyPi.yml
-.github/workflows/deploy_anaconda.yml
 .github/workflows/deploy_coverage.yml
 .github/workflows/deploy_documentation.yml
+.github/workflows/deploy_release.yml
 .github/workflows/quality.yml
 .github/workflows/tests.yml
 TypedUnit/__init__.py
@@ -38,7 +37,9 @@ docs/examples/example_1.py
 docs/images/logo.png
 docs/source/code.rst
 docs/source/conf.py
+docs/source/guide.rst
 docs/source/index.rst
+docs/source/reference.rst
 docs/source/references.rst
 docs/source/sg_execution_times.rst
 docs/source/theory.rst

{typedunit-0.2.10 → typedunit-0.2.14}/TypedUnit.egg-info/requires.txt

@@ -4,7 +4,7 @@ matplotlib
 pint_pandas
 
 [documentation]
-MartinPdeS-docs<0.2,>=0.1.4
+MartinPdeS-docs<0.3,>=0.2.1
 numpydoc~=1.8
 sphinx>=6
 sphinx-gallery~=0.17

{typedunit-0.2.10 → typedunit-0.2.14}/TypedUnit.egg-info/scm_file_list.json

@@ -3,10 +3,9 @@
     ".coveragerc",
     ".flake8",
     ".github/dependabot.yml",
-    ".github/workflows/deploy_PyPi.yml",
-    ".github/workflows/deploy_anaconda.yml",
     ".github/workflows/deploy_coverage.yml",
     ".github/workflows/deploy_documentation.yml",
+    ".github/workflows/deploy_release.yml",
     ".github/workflows/quality.yml",
     ".github/workflows/tests.yml",
     ".gitignore",
@@ -34,12 +33,14 @@
     "docs/source/_static/thumbnail.png",
     "docs/source/code.rst",
     "docs/source/conf.py",
+    "docs/source/guide.rst",
     "docs/source/guide/concepts.rst",
     "docs/source/guide/installation.rst",
     "docs/source/guide/pint.rst",
     "docs/source/guide/quickstart.rst",
     "docs/source/guide/validation.rst",
     "docs/source/index.rst",
+    "docs/source/reference.rst",
     "docs/source/references.rst",
     "docs/source/sg_execution_times.rst",
     "docs/source/theory.rst",

typedunit-0.2.14/TypedUnit.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.2.14",
+  "distance": 0,
+  "node": "g71aab5d7965e52e0ef97535d7f3a969c3cc79d38",
+  "dirty": true,
+  "branch": "HEAD",
+  "node_date": "2026-10-21"
+}

{typedunit-0.2.10 → typedunit-0.2.14}/docs/source/conf.py

@@ -1,16 +1,12 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import os
 from pathlib import Path
 
-from sphinx_gallery.sorting import FileNameSortKey
-
 from martinpdes_docs import configure
 
 
 package_name = "TypedUnit"
-version = os.getenv("tag", "latest")
 logo = "../images/logo.png"
 thumbnail = str(Path(__file__).parent.parent / "images" / "logo.png")
 
@@ -19,12 +15,9 @@ globals().update(
         project="TypedUnits",
         package=package_name,
         repository="MartinPdeS/TypedUnit",
-        version=version,
         logo=logo,
         favicon=logo,
-        sphinx_gallery_conf={
-            "default_thumb_file": thumbnail,
-            "within_subsection_order": FileNameSortKey,
-        },
+        gallery_default_thumb=thumbnail,
+        html_theme_options={"show_nav_level": 1},
     )
 )

typedunit-0.2.14/docs/source/guide.rst

@@ -0,0 +1,14 @@
+Guide
+=====
+
+Learn the TypedUnit vocabulary, validation model, and Pint integration.
+
+.. toctree::
+    :maxdepth: 2
+
+    guide/installation
+    guide/quickstart
+    guide/concepts
+    guide/validation
+    guide/pint
+    theory

typedunit-0.2.14/docs/source/index.rst

@@ -0,0 +1,76 @@
+**Date**: |today|, **Version**: |version|
+
+TypedUnit documentation
+=======================
+
+TypedUnit adds readable, runtime-checkable physical quantity types to Pint.
+It keeps Pint's quantity objects and operations while giving APIs a vocabulary
+for physical meaning such as ``Length``, ``Energy``, and ``Frequency``.
+
+Start here
+----------
+
+A typical TypedUnit workflow has three small steps:
+
+#. Create values with the shared :data:`TypedUnit.ureg` registry.
+#. Annotate boundaries with the dimensional type that the value represents.
+#. Add :func:`TypedUnit.validate_units` where runtime validation is useful.
+
+This keeps unit conversion and arithmetic in Pint while making interfaces
+self-documenting and checking dimensional mistakes close to their source.
+
+.. code-block:: python
+
+   from TypedUnit import Energy, ureg, validate_units
+
+   @validate_units
+   def efficiency(input_energy: Energy, output_energy: Energy) -> float:
+       return (output_energy / input_energy).to_base_units().magnitude
+
+   input_energy = 2 * ureg.kilojoule
+   output_energy = 500 * ureg.joule
+   print(efficiency(input_energy, output_energy))
+
+Choose a path
+-------------
+
+* New to TypedUnit? Read :doc:`guide/installation` and :doc:`guide/quickstart`.
+* Designing an API? See :doc:`guide/concepts` and :doc:`guide/validation`.
+* Integrating with Pint or NumPy? Read :doc:`guide/pint`.
+* Looking for a type or helper? Open :doc:`units` and :doc:`code`.
+* Want runnable examples? Browse :doc:`gallery/index`.
+
+What TypedUnit provides
+-----------------------
+
+TypedUnit supplies a shared registry, dimensional marker classes, and an
+optional validation decorator. Marker classes describe what a value means;
+they do not replace Pint quantities or introduce a second unit system.
+
+The package is intentionally small at integration boundaries. Existing Pint
+quantities can be passed through TypedUnit annotations, converted normally,
+and used with NumPy. Applications can adopt the annotations incrementally,
+starting with public functions and configuration models.
+
+Compatibility notes
+-------------------
+
+Use :data:`TypedUnit.ureg` throughout an application. Quantities created by a
+second Pint registry may have compatible dimensions but are different runtime
+objects, which can make validation and comparisons surprising. Convert values
+at library boundaries and keep registry ownership explicit.
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    Guide <guide>
+    Reference <reference>
+    Examples <gallery/index>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

typedunit-0.2.14/docs/source/reference.rst

@@ -0,0 +1,11 @@
+Reference
+=========
+
+Browse the public unit types, helpers, and generated API documentation.
+
+.. toctree::
+    :maxdepth: 2
+
+    units
+    code
+    references

{typedunit-0.2.10 → typedunit-0.2.14}/pyproject.toml

@@ -56,7 +56,7 @@ testing = [
 ]
 
 documentation = [
-    "MartinPdeS-docs>=0.1.4,<0.2",
+    "MartinPdeS-docs>=0.2.1,<0.3",
     "numpydoc ~=1.8",
     "sphinx >=6",
     "sphinx-gallery ~=0.17",

typedunit-0.2.10/.github/workflows/deploy_PyPi.yml

@@ -1,18 +0,0 @@
-name: Publish to PyPI
-
-on:
-  push:
-    tags: ["v*"]
-
-permissions:
-  contents: read
-
-jobs:
-  publish:
-    uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@a01969bc5af90666281f9d37acffdf6a4629763a
-    with:
-      python-version: "3.11"
-      # The reusable workflow wraps this command in double quotes.
-      test-command: python -c 'import TypedUnit; print(TypedUnit.__version__)'
-    secrets:
-      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

typedunit-0.2.10/TypedUnit.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.2.10",
-  "distance": 0,
-  "node": "g156c1ff077ca68e8002b447cedd677d7dfa3c429",
-  "dirty": true,
-  "branch": "HEAD",
-  "node_date": "2026-10-20"
-}

typedunit-0.2.10/docs/source/index.rst

@@ -1,39 +0,0 @@
-**Date**: |today|, **Version**: |version|
-
-
-.. include:: ../../README.rst
-    :start-line: 0
-
-TypedUnit documentation
-=======================
-
-TypedUnit adds readable, runtime-checkable physical quantity types to Pint.
-Keep constructing and converting quantities with Pint, then use types such as
-``Energy`` in annotations, ``isinstance`` checks, and validated boundaries.
-
-.. toctree::
-    :maxdepth: 2
-    :caption: User guide
-
-    guide/installation
-    guide/quickstart
-    guide/concepts
-    guide/validation
-    guide/pint
-    theory
-
-.. toctree::
-    :maxdepth: 2
-    :caption: Reference
-
-    units
-    code
-    references
-    gallery/index
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`