swopy 0.1.1__tar.gz

swopy-0.1.1/.github/dependabot.yaml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    # Look for `uv.lock` file in the root directory.
+    directory: "/"
+    # Check the registry for updates every day (weekdays)
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the default location of `.github/workflows`
+    # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    allow:
+      - dependency-type: "direct"
+      - dependency-type: "indirect"

swopy-0.1.1/.github/workflows/ci.yaml

@@ -0,0 +1,80 @@
+name: Checks
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test with ${{ matrix.env }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        env:
+          - "3.15.0a5"
+          - "3.14.3"
+          - "3.14.2"
+          - "3.14.1"
+          - "3.14.0"
+          - "3.13"
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: check_changes
+        with:
+          filters: |
+            relevant:
+              - '**/*.py'
+              - '**/*.toml'
+              - '**/*.lock'
+              - '.python-version'
+      
+      - name: Skip message
+        if: ${{ !(steps.check_changes.outputs.relevant == 'true') }}
+        run: echo "Skipping Python checks - no relevant changes detected"
+
+      - name: Install the latest version of uv
+        if: steps.check_changes.outputs.relevant == 'true'
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v6.8.0
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      
+      - name: Add .local/bin to Windows PATH
+        if: steps.check_changes.outputs.relevant == 'true' && runner.os == 'Windows'
+        shell: bash
+        run: echo "$USERPROFILE/.local/bin" >> $GITHUB_PATH
+      
+      - name: Install tox
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv tool install --python-preference only-managed --python 3.14 tox --with tox-uv --with tox-gh
+      
+      - name: Install Python
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv python install --python-preference only-managed ${{ matrix.env }}
+      
+      - name: Setup test suite
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: tox run -vv --notest --skip-missing-interpreters false
+        env:
+          TOX_GH_MAJOR_MINOR: ${{ matrix.env }}
+      
+      - name: Run test suite
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: tox run --skip-pkg-install
+        env:
+          TOX_GH_MAJOR_MINOR: ${{ matrix.env }}

swopy-0.1.1/.github/workflows/publish.yaml

@@ -0,0 +1,37 @@
+name: Publish to PyPI and Docker
+
+on:
+  release:
+    types: [published]
+
+
+permissions:
+  contents: read
+
+jobs:
+  run:
+    name: "Build and publish release"
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for OIDC authentication
+      contents: read
+
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Install uv
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version-file: ".python-version"
+      - name: Build
+        run: uv build
+      - name: Publish to PyPI test
+        run: uv publish --index testpypi
+      - name: Publish
+        run: uv publish

swopy-0.1.1/.github/workflows/tag-and-release.yaml

@@ -0,0 +1,76 @@
+name: Version Bump and Release
+
+on:
+  workflow_dispatch: # Allow manual triggering
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - '.github/**'
+      - 'scripts/**'
+      - 'tests/**'
+      - '.gitignore'
+      - '.pre-commit-config.yaml'
+      - 'pyproject.toml'
+      - 'tox.toml'
+      - 'uv.lock'
+
+permissions:
+  contents: read
+
+jobs:
+  bump-version-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0  # Fetch all history for proper tag creation
+          token: ${{ secrets.BOT_TOKEN }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@803947b9bd8e9f986429fa0c5a41c367cd732b41 # v7.2.1
+
+      - name: Current version
+        id: current_version
+        run: |
+          CURRENT_VERSION=$(uv version | awk '{print $2}')
+          PATCH=$("$CURRENT_VERSION" | cut -d '.' -f 2)
+          echo "patch=$PATCH" >> $GITHUB_OUTPUT
+
+      # If a new minor or major version tag has been pushed then don't
+      # bump the patch version.
+      - name: Bump version
+        if: steps.current_version.outputs.patch != '0'
+        run: |
+          uv version --bump patch
+      
+      - name: New version
+        id: new_version
+        run: |
+          NEW_VERSION=$(uv version | awk '{print $2}')
+          echo "tag=$NEW_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Commit version change
+        run: |
+          git config --local user.email "218805929+amati-bot@users.noreply.github.com"
+          git config --local user.name "amati[bot]"
+          git commit uv.lock pyproject.toml -m "Bump version to ${{ steps.new_version.outputs.tag }}"
+          git push origin
+
+      - name: Create and push tag
+        run: |
+          git tag ${{ steps.new_version.outputs.tag }}
+          git push --tags
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.BOT_TOKEN }}
+        run: |
+          gh release create ${{ steps.new_version.outputs.tag }} \
+            --title "${{ steps.new_version.outputs.tag }}" \
+            --generate-notes \
+            --latest

swopy-0.1.1/.gitignore

@@ -0,0 +1,17 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.coverage
+.hypothesis/
+
+# Virtual environments
+.venv
+
+
+# MacOS
+.DS_Store
+tests/.DS_Store

swopy-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.13
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [--fix]
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.28.0
+  hooks:
+    - id: gitleaks
+- repo: https://github.com/koalaman/shellcheck-precommit
+  rev: v0.7.2
+  hooks:
+    - id: shellcheck
+      args: [-x]
+- repo: https://github.com/fpgmaas/deptry.git
+  rev: 0.24.0
+  hooks:
+    - id: deptry

swopy-0.1.1/.python-version

@@ -0,0 +1 @@
+3.14.3

swopy-0.1.1/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: swopy
+Version: 0.1.1
+Summary: A collection of numeral system converters.
+Author-email: Ben <2551337+ben-alexander@users.noreply.github.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# Swopy
+
+A Python library for converting between different numeral systems.
+
+## Overview
+
+Swopy provides a simple and extensible interface to convert numbers between various numeral systems, including Roman numerals and Egyptian hieroglyphic numerals. The library supports bidirectional conversion—you can convert from any supported system to any other.
+
+## Supported Numeral Systems
+
+* [Roman](swopy/systems/roman.py), in the forms
+ * Early, supporting integers between 1 and 899
+ * Standard, supporting integers between 1 and 3,999
+ * Apostrophus, supporting integers between 1 and 100,000
+* [Egyptian](umberology/systems/egyptian.py), supporting integers between 1 and 1,000,000/many
+* Arabic, supporting integers between `-int(sys.float_info.max)` and `int(sys.float_info.max)`
+
+## Installation
+
+Install the package:
+
+```bash
+pip install swopy # or
+uv add swopy
+```
+
+## Usage
+
+### Basic Conversion
+
+```python
+from swopy import Swopy, systems
+
+converter = Swopy()
+
+# Convert integer Roman numeral to Egyptian hieroglyphic
+converter.convert('IX', systems.roman.Standard, systems.egyptian.Egyptian)
+# '𓏺𓏺𓏺𓏺𓏺𓏺𓏺𓏺𓏺'
+
+# Convert Apostrophus to an Arabic integer
+converter.convert('IↃI', systems.roman.Apostrophus, systems.arabic.Arabic)
+# 501
+```
+
+### Available Systems
+
+```python
+from swopy import Swopy, get_all_systems
+import pprint
+systems = get_all_systems()
+pprint.pprint(systems)
+#{'arabic.Arabic': <class 'swopy.systems.arabic.Arabic'>,
+# 'egyptian.Egyptian': <class 'swopy.systems.egyptian.Egyptian'>,
+# 'roman.Apostrophus': <class 'swopy.systems.roman.Apostrophus'>,
+# 'roman.Early': <class 'swopy.systems.roman.Early'>,
+# 'roman.Standard': <class 'swopy.systems.roman.Standard'>}
+
+converter = Swopy()
+converter.convert(42, systems['arabic.Arabic'], systems['roman.Early'])
+# 'XLII'
+
+```
+
+### Error Handling
+
+The library validates numbers against the acceptable range for each system:
+
+```python
+from swopy import Swopy, systems
+
+converter = Swopy()
+
+# This will raise ValueError (4000 is outside the valid range)
+try:
+    result = converter.convert(4000, systems.arabic.Arabic, systems.roman.Standard)
+except ValueError as e:
+    print(f"Conversion failed: {e}")
+# Conversion failed: Number must be less than or equal to 3999.
+```
+
+## Requirements
+
+- Python 3.13 or higher
+
+## Development
+
+### Dependencies
+
+Development dependencies are managed through `pyproject.toml`:
+
+```bash
+# Install development dependencies
+sh scripts/startup.sh
+```
+
+Dev tools include:
+- pytest / pytest-cov: Testing framework
+- ruff: Fast Python linter and formatter
+- pyright: Static type checker
+- deptry: Dependency validation
+- hypothesis: Property-based testing
+- pre-commit: Git hooks framework
+- tox, with tox-uv: Test runner
+- uv

swopy-0.1.1/README.md

@@ -0,0 +1,104 @@
+# Swopy
+
+A Python library for converting between different numeral systems.
+
+## Overview
+
+Swopy provides a simple and extensible interface to convert numbers between various numeral systems, including Roman numerals and Egyptian hieroglyphic numerals. The library supports bidirectional conversion—you can convert from any supported system to any other.
+
+## Supported Numeral Systems
+
+* [Roman](swopy/systems/roman.py), in the forms
+ * Early, supporting integers between 1 and 899
+ * Standard, supporting integers between 1 and 3,999
+ * Apostrophus, supporting integers between 1 and 100,000
+* [Egyptian](umberology/systems/egyptian.py), supporting integers between 1 and 1,000,000/many
+* Arabic, supporting integers between `-int(sys.float_info.max)` and `int(sys.float_info.max)`
+
+## Installation
+
+Install the package:
+
+```bash
+pip install swopy # or
+uv add swopy
+```
+
+## Usage
+
+### Basic Conversion
+
+```python
+from swopy import Swopy, systems
+
+converter = Swopy()
+
+# Convert integer Roman numeral to Egyptian hieroglyphic
+converter.convert('IX', systems.roman.Standard, systems.egyptian.Egyptian)
+# '𓏺𓏺𓏺𓏺𓏺𓏺𓏺𓏺𓏺'
+
+# Convert Apostrophus to an Arabic integer
+converter.convert('IↃI', systems.roman.Apostrophus, systems.arabic.Arabic)
+# 501
+```
+
+### Available Systems
+
+```python
+from swopy import Swopy, get_all_systems
+import pprint
+systems = get_all_systems()
+pprint.pprint(systems)
+#{'arabic.Arabic': <class 'swopy.systems.arabic.Arabic'>,
+# 'egyptian.Egyptian': <class 'swopy.systems.egyptian.Egyptian'>,
+# 'roman.Apostrophus': <class 'swopy.systems.roman.Apostrophus'>,
+# 'roman.Early': <class 'swopy.systems.roman.Early'>,
+# 'roman.Standard': <class 'swopy.systems.roman.Standard'>}
+
+converter = Swopy()
+converter.convert(42, systems['arabic.Arabic'], systems['roman.Early'])
+# 'XLII'
+
+```
+
+### Error Handling
+
+The library validates numbers against the acceptable range for each system:
+
+```python
+from swopy import Swopy, systems
+
+converter = Swopy()
+
+# This will raise ValueError (4000 is outside the valid range)
+try:
+    result = converter.convert(4000, systems.arabic.Arabic, systems.roman.Standard)
+except ValueError as e:
+    print(f"Conversion failed: {e}")
+# Conversion failed: Number must be less than or equal to 3999.
+```
+
+## Requirements
+
+- Python 3.13 or higher
+
+## Development
+
+### Dependencies
+
+Development dependencies are managed through `pyproject.toml`:
+
+```bash
+# Install development dependencies
+sh scripts/startup.sh
+```
+
+Dev tools include:
+- pytest / pytest-cov: Testing framework
+- ruff: Fast Python linter and formatter
+- pyright: Static type checker
+- deptry: Dependency validation
+- hypothesis: Property-based testing
+- pre-commit: Git hooks framework
+- tox, with tox-uv: Test runner
+- uv

swopy-0.1.1/pyproject.toml

@@ -0,0 +1,123 @@
+[project]
+name = "swopy"
+version = "0.1.1"
+description = "A collection of numeral system converters."
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [
+    { name = "Ben", email = "2551337+ben-alexander@users.noreply.github.com" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = []
+
+
+[dependency-groups]
+dev = [
+    "deptry",
+    "hypothesis",
+    "pre-commit",
+    "pyright",
+    "pytest",
+    "pytest-cov",
+    "ruff",
+]
+
+[tool.coverage.run]
+relative_files=true
+omit=[
+    "tests/*",
+]
+
+[tool.deptry.package_module_name_map]
+hypothesis="hypothesis"
+pre_commit="pre_commit"
+pyright="pyright"
+pytest="pytest"
+pytest-cov="pytest_cov"
+ruff="ruff"
+
+[tool.pyright]
+reportMissingTypeStubs=false
+reportMissingImports=false # Ignore external dependencies
+typeCheckingMode="strict"
+include = ["swopy"]
+
+[tool.pytest.ini_options]
+doctest_optionflags = "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS"
+addopts = "--strict-markers"
+markers = [
+    "external: requires external dependencies"
+    ]
+
+[tool.uv]
+package = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["swopy"]
+include = [
+    "/swopy/py.typed",
+]
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple/"
+default = true
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/legacy/"
+publish-url = "https://test.pypi.org/legacy/"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "A",   # flake8-builtins
+    "ARG", # flake8-arguments
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "C90", # McCabe complexity
+    "DTZ", # flake8-datetimez
+    "E",   # pycodestyle errors
+    "ERA", # eradicate (commented out code)
+    "F",   # pyflakes
+    "I",   # isort
+    "ISC", # flake8-implicit-str-concat
+    "PL",  # Pylint
+    "PLC", # Pylint - Convention
+    "PLE", # Pylint - Error
+    "PTH", # flake8-pathlib
+    "PLR", # Pylint - Refactor
+    "PLW", # Pylint - warnings
+    "RUF", # ruff-specific rules
+    "S",   # flake8-bandit
+    "SIM", # flake8-simplify
+    "T20", # flake8-print
+    "UP",  # pyupgrade
+    "W",   # pycodestyle warnings  
+    "YTT", # flake8-2020
+]
+extend-fixable = ["UP015"]
+
+[tool.ruff.lint.isort]
+known-first-party=["swopy"]
+
+[tool.ruff.lint.per-file-ignores]
+# Disable certain checks in tests
+"tests/**/*.py" = [
+    "S101", # Allow assert
+]

swopy-0.1.1/scripts/startup.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+uv python install
+. .venv/bin/activate
+uv sync
+pre-commit install
+uv tool install tox --with tox-uv

swopy-0.1.1/scripts/upgrade-python.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+deactivate || true
+uv self update
+. .venv/bin/activate
+uv python upgrade
+uv python pin "$1"
+uv sync --all-groups

swopy-0.1.1/swopy/__init__.py

@@ -0,0 +1,17 @@
+from . import systems
+from .swopy import (
+    Denotation,
+    Numeral,
+    Swopy,
+    System,
+    get_all_systems,
+)
+
+__all__ = [
+    "Denotation",
+    "Numeral",
+    "Swopy",
+    "System",
+    "get_all_systems",
+    "systems",
+]