finitefree 0.1.0__tar.gz

finitefree-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: FiniteFree CI
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+jobs:
+  test:
+    name: ${{ matrix.os }} / Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install System Dependencies (Linux)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libflint-dev libgmp-dev libmpfr-dev
+
+    - name: Install System Dependencies (macOS)
+      if: matrix.os == 'macos-latest'
+      run: |
+        if command -v brew &> /dev/null; then
+          brew install flint gmp mpfr
+          echo "C_INCLUDE_PATH=/opt/homebrew/include" >> $GITHUB_ENV
+          echo "LIBRARY_PATH=/opt/homebrew/lib" >> $GITHUB_ENV
+        elif command -v apt-get &> /dev/null; then
+          sudo apt-get update
+          sudo apt-get install -y libflint-dev libgmp-dev libmpfr-dev
+        fi
+
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        # Force pre-compiled wheels for python-flint >= 0.6.0 on Windows, fallback on others
+        python -m pip install --only-binary=python-flint "python-flint>=0.6.0" || python -m pip install "python-flint>=0.6.0"
+        # Standard install (not editable) ensures Cython modules compile and link properly
+        pip install .[dev]
+
+    - name: Verify Code Formatting & Linting (Linux only)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        python -m ruff format --check finitefree/ tests/
+        python -m ruff check finitefree/ tests/
+        python -m mypy finitefree/ tests/
+
+    - name: Test with pytest and coverage (Cython Enabled)
+      run: |
+        # Compile Cython module in-place so it is available locally in the source tree, including NumPy headers
+        python -m pip install Cython
+        python -c "from setuptools import setup, Extension; from Cython.Build import cythonize; import numpy as np; setup(ext_modules=cythonize(Extension('finitefree.utils.modular_fast', ['finitefree/utils/modular_fast.pyx'], include_dirs=[np.get_include()])), script_args=['build_ext', '--inplace'])"
+        export PYTHONPATH=.
+        python -m pytest --import-mode=importlib --cov=finitefree --cov-report=xml tests/
+
+    - name: Test with pytest (Cython Disabled Fallback)
+      env:
+        PYFFP_DISABLE_CYTHON: "1"
+      run: |
+        export PYTHONPATH=.
+        python -m pytest --import-mode=importlib tests/
+
+    - name: Mark workspace as safe directory (Linux only)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        git config --global --add safe.directory "${{ github.workspace }}"
+
+    - name: Upload coverage to Codecov (Linux only)
+      if: matrix.os == 'ubuntu-latest'
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: false
+        token: ${{ secrets.CODECOV_TOKEN }}
+        disable_safe_directory: true

finitefree-0.1.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,66 @@
+name: Deploy MkDocs Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Provision C toolchains and arbitrary-precision libraries
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y gcc libgmp-dev libmpfr-dev libflint-dev
+
+      - name: Initialize Python runtime
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Execute local package installation and compile Cython extensions
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          # Force pre-compiled wheels for python-flint, fallback on source
+          python -m pip install --only-binary=python-flint "python-flint>=0.6.0" || python -m pip install "python-flint>=0.6.0"
+          pip install -e ".[dev]"
+          pip install mkdocs-material mkdocstrings[python]
+
+      - name: Construct static documentation assets
+        run: |
+          python scripts/sync_docs.py
+          mkdocs build
+
+      - name: Configure GitHub Pages environment
+        uses: actions/configure-pages@v4
+        with:
+          enablement: true
+
+      - name: Upload compiled artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+      - name: Execute deployment
+        id: deployment
+        uses: actions/deploy-pages@v4

finitefree-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,85 @@
+name: Build and Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+    inputs:
+      publish_to_testpypi:
+        description: 'Publish to TestPyPI instead of PyPI'
+        required: true
+        type: boolean
+        default: true
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build wheels via cibuildwheel
+        uses: pypa/cibuildwheel@v2.21.3
+
+      - name: Upload compiled wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build sdist
+        run: python -m build --sdist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Publish packages to PyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write # Required for Trusted Publishing / OIDC
+
+    steps:
+      - name: Download all build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Publish to TestPyPI
+        # Publish to TestPyPI if triggered by manual dispatch with TestPyPI input, or tags ending in rc/dev
+        if: |
+          (github.event_name == 'workflow_dispatch' && github.event.inputs.publish_to_testpypi == 'true') ||
+          (github.event_name == 'push' && (contains(github.ref, 'rc') || contains(github.ref, 'dev')))
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+      - name: Publish to PyPI
+        # Publish to production PyPI only on clean semver releases (non-pre-release tags)
+        if: |
+          (github.event_name == 'workflow_dispatch' && github.event.inputs.publish_to_testpypi == 'false') ||
+          (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, 'rc') && !contains(github.ref, 'dev'))
+        uses: pypa/gh-action-pypi-publish@release/v1

finitefree-0.1.0/.gitignore

@@ -0,0 +1,90 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+*.c
+*.cpp
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.sveditor
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+
+# Python cache & tooling
+.mypy_cache/
+.ruff_cache/
+
+# Local visual output directory (whitelist key showcase assets and scripts)
+visuals/*
+!visuals/*.py
+!visuals/assets/
+!visuals/assets/*
+
+# Local TODO tracking
+TODO.md
+
+# Convergence Experiment Outputs
+experiments/
+
+# Local Scratch/Development scripts
+scratch/
+
+# MkDocs output
+site/
+
+
+
+

finitefree-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FiniteFree Authors
+
+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.

finitefree-0.1.0/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: finitefree
+Version: 0.1.0
+Summary: A Python library for exact finite free probability
+Author: Author
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.24
+Requires-Dist: python-flint>=0.6.0
+Requires-Dist: scipy>=1.10
+Requires-Dist: sympy>=1.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.3.0; extra == 'dev'