PicoUnits 0.0.1__tar.gz

picounits-0.0.1/.github/workflows/publish_lower_picounits.yml

@@ -0,0 +1,34 @@
+name: Publish Picounits (Lowercase)
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+      - '*.*.*'
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write 
+    environment: 
+      name: pypi 
+    
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    
+    - name: Install build tools
+      run: python -m pip install --upgrade pip build
+      
+    - name: Build package
+      run: python -m build
+      
+    - name: Publish package to PyPI (picounits)
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        targets: picounits 

picounits-0.0.1/.github/workflows/publish_picounits.yml

@@ -0,0 +1,38 @@
+name: Publish PicoUnits (Capitalized)
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+      - '*.*.*'
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write 
+    environment: 
+      name: pypi 
+    
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    
+    - name: Install build tools
+      run: python -m pip install --upgrade pip build
+      
+    - name: Temporarily set name to PicoUnits
+      run: |
+        sed -i 's/name = "picounits"/name = "PicoUnits"/g' pyproject.toml
+      
+    - name: Build package
+      run: python -m build
+      
+    - name: Publish package to PyPI (PicoUnits)
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        targets: PicoUnits

picounits-0.0.1/LICENSE

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

picounits-0.0.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: PicoUnits
+Version: 0.0.1
+Summary: SI Based Unit System With Minimal Overhead And Maximal Speed
+Project-URL: Homepage, https://github.com/wgbowley/picounits
+Project-URL: Bug Tracker, https://github.com/wgbowley/picounits/issues
+Author-email: William Bowley <wgrantbowley@gmail.com>
+Maintainer-email: William Bowley <wgrantbowley@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 William Bowley
+        
+        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.
+License-File: LICENSE
+Keywords: high-performance,minimal,physics,si,units
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="media/banner.png" alt="PicoUnits" style="max-width:600px;">
+  <br>
+  <em>SI Unit System Designed For Minimal Overhead  – Built with speed by <a href="https://github.com/wgbowley">William Bowley</a></em>
+</p>
+
+## Overview
+
+![Work in Progress](https://img.shields.io/badge/status-wip-orange)
+![Python Version](https://img.shields.io/badge/python-3.10+-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+
+**PicoUnits** is a low overhead library designed for ensuring dimensional accuracy during runtime. It uses a custom seven fundamental unit system based off the standard SI metric fundamental units. 
+
+```py
+class SIBase(Enum):
+    """ SI metric fundamental units expect mass is defined as a gram """
+    SECOND = auto()             # Time
+    METER = auto()              # Length
+    GRAM = auto()               # Mass
+    AMPERE = auto()             # Electric Current
+    KELVIN = auto()             # Temperature
+    MOLE = auto()               # Amount of a substance
+    CANDELA = auto()            # Luminous Intensity
+    DIMENSIONLESS = auto()      # Non-physical quantity
+```
+
+Each unit is made up of a subclass called `Dimension` which itself is made of two sub-dataclasses `SIBase`, `PrefixScale` and one integer value `exponent`:
+
+```py
+@dataclass()
+class Dimension:
+    """
+    Defines a SI metric dimension through 'SIBase', 'PrefixScale and 'exponent'
+    """
+    prefix: PrefixScale = PrefixScale.BASE
+    base: SIBase = SIBase.DIMENSIONLESS
+    exponent: int = 1
+
+class Unit:
+    """
+    Defines a SI metric unit composed of a singular or multiple 'Dimension'.
+    """
+    def __init__(self, *dimensions: Dimension) -> None:
+        self.dimensions = list(dimensions)
+```
+
+
+
+Each `Quantity` has both a magnitude and unit, and through the usage of dunder methods dimensional analysis happens in parallel with arithmetic operations.  
+
+```py
+@dataclass
+class Quantity:
+    """
+    Represents a quantity within the framework with both magnitude and unit
+    """
+    magnitude: float | int
+    unit: Unit
+```
+
+## Installation
+
+PicoUnits requires Python 3.10 or newer.
+
+```bash
+pip install picounits
+```

picounits-0.0.1/README.md

@@ -0,0 +1,68 @@
+<p align="center">
+  <img src="media/banner.png" alt="PicoUnits" style="max-width:600px;">
+  <br>
+  <em>SI Unit System Designed For Minimal Overhead  – Built with speed by <a href="https://github.com/wgbowley">William Bowley</a></em>
+</p>
+
+## Overview
+
+![Work in Progress](https://img.shields.io/badge/status-wip-orange)
+![Python Version](https://img.shields.io/badge/python-3.10+-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+
+**PicoUnits** is a low overhead library designed for ensuring dimensional accuracy during runtime. It uses a custom seven fundamental unit system based off the standard SI metric fundamental units. 
+
+```py
+class SIBase(Enum):
+    """ SI metric fundamental units expect mass is defined as a gram """
+    SECOND = auto()             # Time
+    METER = auto()              # Length
+    GRAM = auto()               # Mass
+    AMPERE = auto()             # Electric Current
+    KELVIN = auto()             # Temperature
+    MOLE = auto()               # Amount of a substance
+    CANDELA = auto()            # Luminous Intensity
+    DIMENSIONLESS = auto()      # Non-physical quantity
+```
+
+Each unit is made up of a subclass called `Dimension` which itself is made of two sub-dataclasses `SIBase`, `PrefixScale` and one integer value `exponent`:
+
+```py
+@dataclass()
+class Dimension:
+    """
+    Defines a SI metric dimension through 'SIBase', 'PrefixScale and 'exponent'
+    """
+    prefix: PrefixScale = PrefixScale.BASE
+    base: SIBase = SIBase.DIMENSIONLESS
+    exponent: int = 1
+
+class Unit:
+    """
+    Defines a SI metric unit composed of a singular or multiple 'Dimension'.
+    """
+    def __init__(self, *dimensions: Dimension) -> None:
+        self.dimensions = list(dimensions)
+```
+
+
+
+Each `Quantity` has both a magnitude and unit, and through the usage of dunder methods dimensional analysis happens in parallel with arithmetic operations.  
+
+```py
+@dataclass
+class Quantity:
+    """
+    Represents a quantity within the framework with both magnitude and unit
+    """
+    magnitude: float | int
+    unit: Unit
+```
+
+## Installation
+
+PicoUnits requires Python 3.10 or newer.
+
+```bash
+pip install picounits
+```

picounits-0.0.1/cSpell.json

@@ -0,0 +1,20 @@
+{
+  "version": "0.2",
+  "language": "en-US",
+  "words": [
+    "picounits",
+    "bowley",
+    "femm",
+    "giga",
+    "hecto",
+    "deka",
+    "deci",
+    "centi",
+    "milli",
+    "pico",
+    "pyfemm",
+    "Dunder",
+    "dataclasses",
+    "dataclass"
+  ]
+}

picounits-0.0.1/picounits/__init__.py

@@ -0,0 +1 @@
+# PicoUnits/__init__.py

picounits-0.0.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "PicoUnits"
+version = "0.0.1"
+description = "SI Based Unit System With Minimal Overhead And Maximal Speed"
+readme = "README.md"
+authors = [
+  { name = "William Bowley", email = "wgrantbowley@gmail.com" },
+]
+maintainers = [
+  { name = "William Bowley", email = "wgrantbowley@gmail.com" },
+]
+license = { file = "LICENSE" }
+keywords = ["units", "si", "high-performance", "minimal", "physics"]
+
+[project.urls]
+"Homepage" = "https://github.com/wgbowley/picounits"
+"Bug Tracker" = "https://github.com/wgbowley/picounits/issues"