cryptils 0.1.0a1__py3-none-any.whl

cryptils/__init__.py

@@ -0,0 +1,6 @@
+from .btc import BTC
+from .eth import ETH
+from .usdc import USDC
+from .usdt import USDT
+
+__all__ = ["BTC", "ETH", "USDC", "USDT"]

cryptils/_core.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from abc import ABCMeta
+from decimal import Decimal
+from typing import Any, ClassVar, TypeAlias
+
+_number_or_str: TypeAlias = Decimal | int | float | str
+
+
+class CryptoAmount(metaclass=ABCMeta):  # noqa: B024
+    _name: ClassVar[str] = ""
+    _symbol: ClassVar[str] = ""
+    _decimals: ClassVar[int] = 0
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def symbol(self) -> str:
+        return self._symbol
+
+    def __init__(self, value: _number_or_str) -> None:
+        if type(self) is CryptoAmount:
+            raise TypeError("CryptoAmount is an abstract class and cannot be instantiated directly")
+        self._value = self._to_decimal(value)
+
+    def _to_decimal(self, value: _number_or_str) -> Decimal:
+        return Decimal(value).quantize(Decimal(10) ** -self._decimals)
+
+    def as_decimal(self) -> Decimal:
+        return self._value
+
+    def to_string(self):
+        return f"{self._value:.{self._decimals}f} {self._symbol}"
+
+    def __str__(self) -> str:
+        return str(self._value)
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}({self.to_string()})"
+
+    def _is_compatible(self, other: Any) -> bool:
+        return isinstance(other, _number_or_str)
+
+    def _compare(self, other: Any) -> Decimal:
+        if isinstance(other, self.__class__):
+            return other._value
+        if self._is_compatible(other):
+            return self._to_decimal(other)
+        return NotImplemented
+
+    def __eq__(self, other: Any) -> bool:
+        other_value = self._compare(other)
+        if other_value is NotImplemented:
+            return NotImplemented
+        return self._value == other_value
+
+    def __lt__(self, other: Any) -> bool:
+        other_value = self._compare(other)
+        if other_value is NotImplemented:
+            return NotImplemented
+        return self._value < other_value
+
+    def __le__(self, other: Any) -> bool:
+        other_value = self._compare(other)
+        if other_value is NotImplemented:
+            return NotImplemented
+        return self._value <= other_value
+
+    def __gt__(self, other: Any) -> bool:
+        other_value = self._compare(other)
+        if other_value is NotImplemented:
+            return NotImplemented
+        return self._value > other_value
+
+    def __ge__(self, other: Any) -> bool:
+        other_value = self._compare(other)
+        if other_value is NotImplemented:
+            return NotImplemented
+        return self._value >= other_value
+
+    def __hash__(self) -> int:
+        return hash((self.__class__, self._value))
+
+    def __add__(self, other: Any) -> CryptoAmount:
+        if isinstance(other, self.__class__):
+            return self.__class__(self._value + other._value)
+        if self._is_compatible(other):
+            return self.__class__(self._value + self._to_decimal(other))
+        return NotImplemented
+
+    def __radd__(self, other: Any) -> CryptoAmount:
+        return self.__add__(other)
+
+    def __sub__(self, other: Any) -> CryptoAmount:
+        if isinstance(other, self.__class__):
+            return self.__class__(self._value - other._value)
+        if self._is_compatible(other):
+            return self.__class__(self._value - self._to_decimal(other))
+        return NotImplemented
+
+    def __rsub__(self, other: Any) -> CryptoAmount:
+        if self._is_compatible(other):
+            return self.__class__(self._to_decimal(other) - self._value)
+        return NotImplemented
+
+    def __mul__(self, other: Any) -> CryptoAmount:
+        if isinstance(other, self.__class__):
+            raise TypeError(f"Cannot multiply two {type(self).__name__} instances")
+        if self._is_compatible(other):
+            return self.__class__(self._value * self._to_decimal(other))
+        return NotImplemented
+
+    def __rmul__(self, other: Any) -> CryptoAmount:
+        return self.__mul__(other)
+
+    def __truediv__(self, other: Any) -> CryptoAmount:
+        if isinstance(other, self.__class__):
+            raise TypeError(f"Cannot divide two {type(self).__name__} instances")
+        if self._is_compatible(other):
+            return self.__class__(self._value / self._to_decimal(other))
+        return NotImplemented
+
+    def __rtruediv__(self, other: Any) -> CryptoAmount:
+        if self._is_compatible(other):
+            return self.__class__(self._to_decimal(other) / self._value)
+        return NotImplemented

cryptils/btc.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from ._core import CryptoAmount
+
+
+class BTC(CryptoAmount):
+    _name = "Bitcoin"
+    _symbol = "BTC"
+    _decimals = 8

cryptils/eth.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from ._core import CryptoAmount
+
+
+class ETH(CryptoAmount):
+    _name = "Ethereum"
+    _symbol = "ETH"
+    _decimals = 18

cryptils/py.typed

@@ -0,0 +1 @@
+# py.typed marker file for PEP 561

cryptils/usdc.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from ._core import CryptoAmount
+
+
+class USDC(CryptoAmount):
+    _name = "USD Coin"
+    _symbol = "USDC"
+    _decimals = 6

cryptils/usdt.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from ._core import CryptoAmount
+
+
+class USDT(CryptoAmount):
+    _name = "Tether"
+    _symbol = "USDT"
+    _decimals = 6

cryptils-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: cryptils
+Version: 0.1.0a1
+Summary: A simple python utility library for representing cryptocurrency amounts
+Project-URL: Homepage, https://github.com/seba3c/cryptils
+Project-URL: Repository, https://github.com/seba3c/cryptils
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Requires-Dist: tox>=4.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cryptils
+
+![Tests](https://github.com/seba3c/cryptils/actions/workflows/tests.yml/badge.svg)
+![Coverage](https://img.shields.io/badge/coverage-90%25-brightgreen)
+![License](https://img.shields.io/badge/license-MIT-blue)
+![PyPI](https://img.shields.io/pypi/v/cryptils)
+![TestPyPI](https://img.shields.io/badge/testpypi-v0.1.0a1-blue)
+
+An utility library for representing cryptocurrency amounts in Python.
+
+## Installation
+
+```bash
+pip install cryptils
+```
+
+## Quick Start
+
+```python
+from cryptils import BTC, ETH, USDC, USDT
+
+# Create amounts with exact decimal precision
+btc = BTC("1.5")
+print(btc)  # 1.50000000 BTC
+
+eth = ETH("2.0")
+print(eth)  # 2.000000000000000000 ETH
+
+# Arithmetic
+result = BTC("0.5") + BTC("0.25")
+print(result)  # 0.75000000 BTC
+
+# Different currencies maintain their own precision
+usdc = USDC("100")
+print(usdc)  # 100.000000 USDC
+
+# Access the raw Decimal value
+print(btc.as_decimal())  # Decimal('1.50000000')
+
+# Get the formatted string explicitly
+print(btc.to_string())  # 1.50000000 BTC
+```
+
+## Features
+
+- Uses `decimal.Decimal` internally to avoid floating-point errors.
+- Consistent precision handling per currency (e.g., 8 decimals for BTC, 6 for USDC).
+- Simple, explicit API designed for financial precision.
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for environment management, [ruff](https://docs.astral.sh/ruff/) for linting and formatting, and [tox](https://tox.wiki/) for testing across Python versions.
+
+```bash
+# Setup environment
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run tests across all supported Python versions
+uv run tox
+
+# Format and lint
+uv run ruff check --fix .
+uv run ruff format .
+
+# Install pre-commit hooks
+uv run pre-commit install
+
+# Run pre-commit on all files
+uv run pre-commit run --all-files
+```
+
+## License
+
+[MIT](./LICENSE)

cryptils-0.1.0a1.dist-info/RECORD

@@ -0,0 +1,11 @@
+cryptils/__init__.py,sha256=t-HZlI9wKlLaRr6F6U6AmIPdb4beZoU-XNonDIf0UjM,130
+cryptils/_core.py,sha256=BGvQeLSLt4Y_cJ_SnZ86NPnhmB-XCicdpVMFgfReeE0,4433
+cryptils/btc.py,sha256=0Tmbni5z6ZLFG5w_hEeLlG_lHG_5adyFU9Qfs4pBQmo,155
+cryptils/eth.py,sha256=WMo_q88Or_BfqRvu6vkisyfw9V9rLncmZQzIKlfZeEk,157
+cryptils/py.typed,sha256=-yl3TJziRnBGR4RQVDoLxLVJCMoslIXZL48QaM0ulXI,35
+cryptils/usdc.py,sha256=YA-nUd0rbhoxPXMORNzw-FEgO1vFhFqy-KN0u0RWd2Q,158
+cryptils/usdt.py,sha256=LEB_Zi_JaKjqgCzJWn1xKalldznfbU8glGmYdtz2trY,156
+cryptils-0.1.0a1.dist-info/METADATA,sha256=qrMbt5kmgHelZDg6B0Lqwr6WJe2YDJ-GwLb4BqDEEo8,2672
+cryptils-0.1.0a1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+cryptils-0.1.0a1.dist-info/licenses/LICENSE,sha256=8h7d-hCmWM6DvUzHq-_svNaXoTmtXLDUuBkBSH9eLIk,1078
+cryptils-0.1.0a1.dist-info/RECORD,,

cryptils-0.1.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cryptils-0.1.0a1.dist-info/licenses/LICENSE

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