engunits 0.1.0__tar.gz

engunits-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

engunits-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,23 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+      - run: pytest --cov=engunits

engunits-0.1.0/.gitignore

@@ -0,0 +1,43 @@
+# User-specific files
+.claude/
+CLAUDE.md
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+*.so
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing / Coverage
+.coverage
+htmlcov/
+.pytest_cache/
+
+# Linting
+.mypy_cache/
+.ruff_cache/
+
+# Docs
+docs/_build/
+
+# Claude Code (user-specific)
+.claude/settings.local.json

engunits-0.1.0/LICENSE

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

engunits-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: engunits
+Version: 0.1.0
+Summary: Typed engineering quantities with SI-default storage, built on pint
+License-Expression: MIT
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.0
+Requires-Dist: pint>=0.24
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0; extra == "dev"
+Requires-Dist: pytest-cov>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.9; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Dynamic: license-file
+
+# engunits
+
+[![Tests](https://github.com/matuscvengros/engunits/actions/workflows/tests.yml/badge.svg)](https://github.com/matuscvengros/engunits/actions/workflows/tests.yml)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
+
+Typed engineering quantities with SI-default storage, built on [pint](https://pint.readthedocs.io/).
+
+## Install
+
+```bash
+pip install engunits
+```
+
+## Quick start
+
+```python
+from engunits import Mass, Length, Velocity
+
+# Create quantities — SI units by default
+m = Mass(1000, "lb")       # stored internally as kg
+l = Length(5, "ft")         # stored internally as m
+
+# Convert on demand
+print(m("kg"))              # 453.592 kg
+print(l("m"))               # 1.524 m
+
+# Callable syntax for conversion
+v = Velocity(100, "m/s")
+print(v("ft/s"))            # 328.084 ft/s
+
+# Arithmetic
+total = Mass(10, "kg") + Mass(5, "kg")
+scaled = Length(3, "m") * 2
+ratio = Mass(30, "kg") / Mass(10, "kg")  # returns float: 3.0
+```
+
+## Supported quantities
+
+| Class             | SI Unit   |
+|-------------------|-----------|
+| `Mass`            | kg        |
+| `Length`          | m         |
+| `Time`           | s         |
+| `Temperature`    | K         |
+| `Velocity`       | m/s       |
+| `Force`          | N         |
+| `Moment`         | N·m       |
+| `Power`          | W         |
+| `Energy`         | J         |
+| `Area`           | m²        |
+| `Volume`         | m³        |
+| `Density`        | kg/m³     |
+| `Pressure`       | Pa        |
+| `AngularVelocity`| rad/s     |
+| `Voltage`        | V         |
+| `Current`        | A         |
+| `Capacity`       | A·h       |
+
+## License
+
+MIT

engunits-0.1.0/README.md

@@ -0,0 +1,62 @@
+# engunits
+
+[![Tests](https://github.com/matuscvengros/engunits/actions/workflows/tests.yml/badge.svg)](https://github.com/matuscvengros/engunits/actions/workflows/tests.yml)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
+
+Typed engineering quantities with SI-default storage, built on [pint](https://pint.readthedocs.io/).
+
+## Install
+
+```bash
+pip install engunits
+```
+
+## Quick start
+
+```python
+from engunits import Mass, Length, Velocity
+
+# Create quantities — SI units by default
+m = Mass(1000, "lb")       # stored internally as kg
+l = Length(5, "ft")         # stored internally as m
+
+# Convert on demand
+print(m("kg"))              # 453.592 kg
+print(l("m"))               # 1.524 m
+
+# Callable syntax for conversion
+v = Velocity(100, "m/s")
+print(v("ft/s"))            # 328.084 ft/s
+
+# Arithmetic
+total = Mass(10, "kg") + Mass(5, "kg")
+scaled = Length(3, "m") * 2
+ratio = Mass(30, "kg") / Mass(10, "kg")  # returns float: 3.0
+```
+
+## Supported quantities
+
+| Class             | SI Unit   |
+|-------------------|-----------|
+| `Mass`            | kg        |
+| `Length`          | m         |
+| `Time`           | s         |
+| `Temperature`    | K         |
+| `Velocity`       | m/s       |
+| `Force`          | N         |
+| `Moment`         | N·m       |
+| `Power`          | W         |
+| `Energy`         | J         |
+| `Area`           | m²        |
+| `Volume`         | m³        |
+| `Density`        | kg/m³     |
+| `Pressure`       | Pa        |
+| `AngularVelocity`| rad/s     |
+| `Voltage`        | V         |
+| `Current`        | A         |
+| `Capacity`       | A·h       |
+
+## License
+
+MIT

engunits-0.1.0/docs/Makefile

@@ -0,0 +1,14 @@
+# Minimal makefile for Sphinx documentation
+
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+.PHONY: help Makefile
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

engunits-0.1.0/docs/api/base.md

@@ -0,0 +1,7 @@
+# base
+
+```{eval-rst}
+.. automodule:: engunits.base
+   :members:
+   :undoc-members:
+```

engunits-0.1.0/docs/api/config.md

@@ -0,0 +1,7 @@
+# config
+
+```{eval-rst}
+.. automodule:: engunits.config
+   :members:
+   :undoc-members:
+```

engunits-0.1.0/docs/api/index.md

@@ -0,0 +1,15 @@
+# API Reference
+
+```{toctree}
+:maxdepth: 1
+
+base
+config
+quantities
+registry
+```
+
+```{eval-rst}
+.. automodule:: engunits
+   :no-members:
+```

engunits-0.1.0/docs/api/quantities.md

@@ -0,0 +1,7 @@
+# quantities
+
+```{eval-rst}
+.. automodule:: engunits.quantities
+   :members:
+   :undoc-members:
+```

engunits-0.1.0/docs/api/registry.md

@@ -0,0 +1,13 @@
+# registry
+
+```{eval-rst}
+.. automodule:: engunits.registry
+   :members:
+   :undoc-members:
+   :exclude-members: ureg
+
+.. data:: ureg
+   :type: pint.UnitRegistry
+
+   Application-wide unit registry instance.
+```

engunits-0.1.0/docs/conf.py

@@ -0,0 +1,34 @@
+project = "engunits"
+copyright = "2026, Matus Cvengros"
+version = "0.1.0"
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "sphinx_autodoc_typehints",
+]
+
+# MyST settings
+myst_enable_extensions = ["colon_fence", "deflist"]
+
+# Autodoc
+autodoc_member_order = "bysource"
+autodoc_typehints = "description"
+
+# Napoleon (Google-style docstrings)
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+
+# Intersphinx — link to numpy/pint docs
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
+
+# Theme
+html_theme = "furo"
+html_title = "engunits"

engunits-0.1.0/docs/index.md

@@ -0,0 +1,9 @@
+# engunits
+
+Typed engineering quantities with SI-default storage, built on pint.
+
+```{toctree}
+:maxdepth: 2
+
+api/index
+```

engunits-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "engunits"
+dynamic = ["version"]
+description = "Typed engineering quantities with SI-default storage, built on pint"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+dependencies = [
+    "numpy>=2.0",
+    "pint>=0.24",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.0",
+    "pytest-cov>=7.0",
+    "ruff>=0.9",
+]
+docs = [
+    "sphinx>=8.0",
+    "furo",
+    "myst-parser",
+    "sphinx-copybutton",
+    "sphinx-autodoc-typehints",
+]
+
+[build-system]
+requires = ["setuptools>=75.0", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["--strict-markers", "--tb=short", "-q"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 99
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "N", "UP", "B", "SIM", "RUF"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["engunits"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"

engunits-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

engunits-0.1.0/src/engunits/__init__.py

@@ -0,0 +1,46 @@
+"""Typed engineering quantities with SI-default storage, built on pint."""
+
+from engunits.quantities import (
+    AngularVelocity,
+    Area,
+    Capacity,
+    Current,
+    Density,
+    Energy,
+    Force,
+    Length,
+    Mass,
+    Moment,
+    Power,
+    Pressure,
+    Temperature,
+    Time,
+    Velocity,
+    Voltage,
+    Volume,
+)
+from engunits.registry import Q_, ureg
+
+__all__ = [
+    "Q_",
+    "AngularVelocity",
+    "Area",
+    "Capacity",
+    "Current",
+    "Density",
+    "Energy",
+    "Force",
+    "Length",
+    "Mass",
+    "Moment",
+    "Power",
+    "Pressure",
+    "Temperature",
+    "Time",
+    "Velocity",
+    "Voltage",
+    "Volume",
+    "ureg",
+]
+
+__version__ = "0.1.0"