rerum 0.2.2__tar.gz

rerum-0.2.2/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=rerum --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Check build
+        run: |
+          pip install build
+          python -m build

rerum-0.2.2/.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install mkdocs mkdocs-material
+
+      - name: Build docs
+        run: mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

rerum-0.2.2/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write  # Required for trusted publishing
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rerum/
+
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # Uses trusted publishing if configured, otherwise falls back to API token
+          password: ${{ secrets.PYPI_API_TOKEN }}
+        # For trusted publishing, configure at:
+        # https://pypi.org/manage/account/publishing/

rerum-0.2.2/.gitignore

@@ -0,0 +1,56 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+.benchmarks/
+
+# MkDocs
+site/

rerum-0.2.2/CLAUDE.md

@@ -0,0 +1,80 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+RERUM (Rewriting Expressions via Rules Using Morphisms) is a pattern matching and term rewriting library for symbolic computation in Python. It provides a DSL for defining rewrite rules and applies them to s-expression-style nested lists.
+
+## Build and Test Commands
+
+```bash
+pip install -e ".[dev]"                    # Install with dev dependencies
+pip install -e ".[docs]"                   # Install with docs dependencies
+pytest                                      # Run all tests
+pytest --cov=rerum --cov-report=term-missing  # With coverage
+pytest rerum/tests/test_guards.py -v       # Single test file
+pytest rerum/tests/test_guards.py::TestGuardParsing::test_parse_when_clause -v  # Single test
+mkdocs serve                               # Local docs server
+mkdocs build                               # Build docs to site/
+```
+
+## Architecture
+
+### Core Modules
+
+**rewriter.py** - Low-level pattern matching engine
+- `match(pattern, expr, bindings)` - Pattern matching with binding extraction
+- `instantiate(skeleton, bindings, fold_funcs)` - Skeleton instantiation with `(! ...)` compute evaluation
+- `rewriter(rules, fold_funcs)` - Factory that creates a simplifier function
+- Preludes: `ARITHMETIC_PRELUDE`, `MATH_PRELUDE`, `PREDICATE_PRELUDE`, `FULL_PRELUDE`
+
+**engine.py** - High-level DSL and rule engine
+- `RuleEngine` - Main API: load rules, apply strategies, manage groups
+- `RuleMetadata` - Rule name, description, priority, condition (guard)
+- `RewriteTrace` / `RewriteStep` - Tracing infrastructure
+- `parse_sexpr()` / `format_sexpr()` - S-expression I/O
+- `E` - Expression builder singleton
+
+**cli.py** - Command-line interface
+- `RerumREPL` - Interactive REPL with readline support
+- `ScriptRunner` - Executes `.rerum` scripts
+- Supports pipe mode, expression mode, custom prelude loading
+
+### Key Design Patterns
+
+- **Rules vs Preludes**: Rules are pure data (DSL/JSON serializable); preludes are Python code defining what `(! op ...)` operations do. Security boundary: rules can only invoke prelude-enabled operations.
+- **Fluent API**: Methods return `self` for chaining: `.with_prelude()`, `.load_dsl()`, `.disable_group()`
+- **Bindings**: `Bindings` class wraps raw bindings with dict-like access; `NoMatch` singleton is falsy
+- **Strategies**: exhaustive (default), once, bottomup, topdown - control rule application order
+
+### DSL Features
+
+```
+@name: (pattern) => (skeleton)                    # Basic rule
+@name[100]: (pattern) => (skeleton)               # With priority (higher fires first)
+@name: (pattern) => (skeleton) when (condition)   # With guard
+[groupname]                                        # Start a named group
+```
+
+Pattern syntax: `?x`, `?x:const`, `?x:var`, `?x:free(v)`, `?x...`
+Skeleton syntax: `:x`, `:x...`, `(! op args...)`
+
+### Expression Representation
+
+Expressions are nested Python lists in prefix notation:
+```python
+["+", "x", ["*", 2, "y"]]  # represents: x + 2*y
+```
+Atoms are strings (variables) or numbers (constants).
+
+## CLI Usage
+
+```bash
+rerum                              # Start REPL
+rerum script.rerum                 # Run script
+rerum -r rules.rules -p full -e "(+ x 0)"  # One-shot evaluation
+echo "(+ x 0)" | rerum -r rules.rules -q   # Pipe mode
+```
+
+REPL commands: `:help`, `:load FILE`, `:rules`, `:clear`, `:prelude NAME`, `:trace on/off`, `:strategy NAME`, `:groups`, `:enable GROUP`, `:disable GROUP`, `:quit`