algroots 0.1.0__tar.gz

algroots-0.1.0/.github/workflows/benchmarks.yml

@@ -0,0 +1,25 @@
+name: Benchmarks
+
+on:
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    env:
+      ALGROOTS_REQUIRE_FLINT: "1"
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install benchmark dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[benchmark]"
+      - name: Run benchmark suite
+        run: python -m pytest benchmarks --benchmark-only --benchmark-json=benchmark.json
+      - uses: actions/upload-artifact@v4
+        with:
+          name: algroots-benchmark
+          path: benchmark.json

algroots-0.1.0/.github/workflows/mutation.yml

@@ -0,0 +1,38 @@
+name: Mutation testing
+
+on:
+  schedule:
+    - cron: "17 5 * * 1"
+  workflow_dispatch:
+
+jobs:
+  targeted-mutation:
+    name: Targeted non-blocking mutation audit
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    env:
+      ALGROOTS_REQUIRE_FLINT: "1"
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install package and mutation tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[test,mutation]"
+      - name: Mutate recognition
+        run: mutmut run "algroots.recognition*"
+        continue-on-error: true
+      - name: Mutate monodromy stopping
+        run: mutmut run "algroots.monodromy_stopping*"
+        continue-on-error: true
+      - name: Mutate monodromy
+        run: mutmut run "algroots.monodromy*"
+        continue-on-error: true
+      - name: Mutate continuation
+        run: mutmut run "algroots.continuation*"
+        continue-on-error: true
+      - name: Show surviving mutants
+        if: always()
+        run: mutmut results || true

algroots-0.1.0/.github/workflows/python-package.yml

@@ -0,0 +1,275 @@
+name: Test, Build, and Publish
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+        exclude:
+          # Keep macOS/Windows coverage useful without multiplying CI cost
+          # unnecessarily. Linux still exercises every supported Python.
+          - os: macos-latest
+            python-version: "3.11"
+          - os: macos-latest
+            python-version: "3.12"
+          - os: macos-latest
+            python-version: "3.13"
+          - os: windows-latest
+            python-version: "3.11"
+          - os: windows-latest
+            python-version: "3.12"
+          - os: windows-latest
+            python-version: "3.13"
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Upgrade packaging tools
+        run: python -m pip install --upgrade pip
+
+      - name: Install package and test dependencies
+        run: python -m pip install -e ".[test]"
+
+      - name: Run test suite
+        run: python -m pytest -ra
+
+  quality:
+    name: Lint, format, coverage, and docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Upgrade packaging tools
+        run: python -m pip install --upgrade pip
+
+      - name: Install development dependencies
+        run: python -m pip install -e ".[test,dev]"
+
+      - name: Ruff lint
+        run: ruff check .
+
+      - name: Ruff formatting
+        run: ruff format --check .
+
+      - name: Compile Python sources
+        run: python -m compileall -q src tests tools
+
+      - name: Run tests with branch coverage
+        run: >
+          python -m pytest
+          --cov=algroots
+          --cov-branch
+          --cov-report=term-missing
+          --cov-report=xml
+          --cov-fail-under=80
+
+  build:
+    name: Build and validate distributions
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - quality
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Install build tools
+        run: >
+          python -m pip install
+          --upgrade
+          build
+          twine
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Check package metadata
+        run: python -m twine check --strict dist/*
+
+      - name: Show distribution contents
+        shell: bash
+        run: |
+          python - <<'PY'
+          from pathlib import Path
+          import tarfile
+          import zipfile
+
+          for path in sorted(Path("dist").iterdir()):
+              print(f"\n=== {path.name} ===")
+
+              if path.suffix == ".whl":
+                  with zipfile.ZipFile(path) as archive:
+                      for name in archive.namelist():
+                          print(name)
+
+              elif path.name.endswith(".tar.gz"):
+                  with tarfile.open(path, "r:gz") as archive:
+                      for member in archive.getnames():
+                          print(member)
+          PY
+
+      - name: Reject generated/cache files in distributions
+        shell: bash
+        run: |
+          python - <<'PY'
+          from pathlib import Path
+          import tarfile
+          import zipfile
+
+          forbidden = (
+              "__pycache__/",
+              ".pytest_cache/",
+              ".coverage",
+              ".pyc",
+          )
+
+          failures = []
+
+          for path in Path("dist").iterdir():
+              if path.suffix == ".whl":
+                  with zipfile.ZipFile(path) as archive:
+                      names = archive.namelist()
+              elif path.name.endswith(".tar.gz"):
+                  with tarfile.open(path, "r:gz") as archive:
+                      names = archive.getnames()
+              else:
+                  continue
+
+              for name in names:
+                  if any(part in name for part in forbidden):
+                      failures.append(f"{path.name}: {name}")
+
+          if failures:
+              raise SystemExit(
+                  "Generated/cache files found in distributions:\n"
+                  + "\n".join(failures)
+              )
+          PY
+
+      - name: Test installed wheel
+        shell: bash
+        run: |
+          python -m venv .venv-wheel
+          . .venv-wheel/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip install dist/*.whl
+          python tools/release_artifact_smoke.py
+
+      - name: Test installed sdist
+        shell: bash
+        run: |
+          python -m venv .venv-sdist
+          . .venv-sdist/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip install dist/*.tar.gz
+          python tools/release_artifact_smoke.py
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+          retention-days: 14
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/algroots
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/algroots
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

algroots-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python bytecode and caches
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.hypothesis/
+.ruff_cache/
+.mypy_cache/
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Build and packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/

algroots-0.1.0/CITATION.cff

@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use algroots in research, please cite the software."
+title: "algroots"
+type: software
+authors:
+  - family-names: "Bhatt"
+    given-names: "Bhuvanesh"
+version: "0.1.0"
+license: "GPL-3.0-only"
+url: "https://pypi.org/project/algroots/"

algroots-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to algroots
+
+Contributions welcome, especially reproducible bugs, difficult algebraic systems, numerical-conditioning regressions, documentation corrections, and tests that expose backend disagreement.
+
+## Development setup
+
+Use Python 3.11 or newer and install the package with its test and development dependencies:
+
+```bash
+python -m pip install -e ".[test,dev]"
+```
+
+Run the full test suite with:
+
+```bash
+python -m pytest
+```
+
+Run the release-quality static checks with:
+
+```bash
+python -m ruff check .
+python -m ruff format --check .
+```
+
+Coverage can be inspected with:
+
+```bash
+python -m pytest --cov=algroots --cov-branch --cov-report=term-missing
+```
+
+## Tests
+
+Every bugfix should include a focused regression test. New public behavior should include tests for normal inputs, boundary cases, invalid inputs, and interactions with relevant alternative backends. For mathematically equivalent representations, prefer differential or metamorphic tests that compare the resulting root sets rather than relying only on one hand-written expected ordering.
+
+The order in which roots are returned is not guaranteed. Tests should compare root sets with a precision-appropriate tolerance unless exact ordering is itself the behavior under test.
+
+## Documentation
+
+Public API changes must be reflected in `docs/api.md`. New capabilities or limitations should update `docs/feature-support-matrix.md` and, where appropriate, `docs/limitations.md`. Executable examples in the README and selected documentation pages are exercised by the test suite.
+
+## Pull requests
+
+Before submitting a pull request, run the full tests, do Ruff linting/ formatting checks, and the coverage command above. Keep changes focused and explain any new mathematical assumptions or guarantee boundaries explicitly.
+
+## Benchmarks
+
+Performance checks are intentionally opt-in so routine test CI is not tied to noisy wall-clock thresholds:
+
+```bash
+python -m pip install -e ".[benchmark]"
+python -m pytest benchmarks --benchmark-only
+```
+
+Use `pytest-benchmark` JSON output or saved baselines when evaluating structural changes to numerical hot paths.