move to uv, ruff

Author: soodoku

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: uv sync --group dev --group test
+    
+    - name: Run ruff linting
+      run: uv run ruff check .
+    
+    - name: Run ruff formatting check
+      run: uv run ruff format --check .
+    
+    - name: Run type checking
+      run: uv run mypy fairlex/
+    
+    - name: Run tests
+      run: uv run pytest -q --color=yes
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python
+      run: uv python install
+    
+    - name: Build package
+      run: uv build

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+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: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python
+      run: uv python install
+    
+    - name: Install dependencies
+      run: uv sync --group docs
+    
+    - name: Build documentation
+      run: |
+        cd docs
+        uv run sphinx-build -b html . _build/html
+    
+    - name: Setup Pages
+      uses: actions/configure-pages@v5
+      
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/_build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/python-package.yml

@@ -0,0 +1,54 @@
+name: Publish Python Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish'
+        required: false
+        type: string
+
+permissions:
+  id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fairlex
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python
+      run: uv python install
+    
+    - name: Install dependencies
+      run: uv sync --group dev
+    
+    - name: Run linting
+      run: uv run ruff check .
+    
+    - name: Run formatting check
+      run: uv run ruff format --check .
+    
+    - name: Run type checking
+      run: uv run mypy fairlex/
+    
+    - name: Run tests
+      run: uv run pytest -q --color=yes
+    
+    - name: Build package
+      run: uv build
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: true

.github/workflows/python-publish.yml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.12.1
+    hooks:
+      - id: mypy
+        args: [--ignore-missing-imports]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: check-added-large-files

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+.PHONY: help clean install test test-cov lint format type-check docs docs-serve build upload dev-install
+
+help: ## Show this help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+clean: ## Clean build artifacts
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	rm -rf .pytest_cache/
+	rm -rf .coverage
+	rm -rf htmlcov/
+	rm -rf docs/build/
+	find . -type d -name __pycache__ -delete
+	find . -type f -name "*.pyc" -delete
+
+install: ## Install package
+	uv pip install -e .
+
+dev-install: ## Install package with development dependencies
+	uv sync --dev
+	pre-commit install
+
+test: ## Run tests
+	pytest
+
+test-cov: ## Run tests with coverage
+	pytest --cov=fairlex --cov-report=html --cov-report=term
+
+lint: ## Run linter
+	ruff check .
+
+format: ## Format code
+	ruff format .
+	ruff check --fix .
+
+type-check: ## Run type checker
+	mypy fairlex/
+
+build: ## Build package
+	uv build
+
+upload: ## Upload to PyPI
+	uv publish
+
+ci: lint type-check test ## Run CI checks

Makefile

@@ -7,7 +7,7 @@
 
 import numpy as np
 
-from fairlex import leximin_weight_fair, evaluate_solution
+from fairlex import evaluate_solution, leximin_weight_fair
 
 
 def main() -> None:
@@ -40,4 +40,4 @@ def main() -> None:
 
 
 if __name__ == "__main__":
-    main()
+    main()

examples/basic_example.py

@@ -29,11 +29,11 @@
 ]
 
 # Public API
-from .calibration import leximin_residual, leximin_weight_fair, CalibrationResult
+from .calibration import CalibrationResult, leximin_residual, leximin_weight_fair
 from .metrics import evaluate_solution
 
 # Expose the package version at runtime
 try:  # pragma: no cover - metadata may not be present in editable installs
     __version__ = version("fairlex")
 except Exception:
-    __version__ = "0.0.0"
+    __version__ = "0.0.0"

fairlex/__init__.py

@@ -35,14 +35,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Callable, Optional, Tuple
 
 import numpy as np
 
 try:
     # SciPy is used for linear programming; HiGHS is fast and reliable.
     from scipy.optimize import linprog  # type: ignore
-except Exception as e:  # pragma: no cover
+except Exception:  # pragma: no cover
     linprog = None  # type: ignore
 
 
@@ -68,12 +67,12 @@ class CalibrationResult:
 
     w: np.ndarray
     epsilon: float
-    t: Optional[float]
+    t: float | None
     status: int
     message: str
 
 
-def _validate_inputs(A: np.ndarray, b: np.ndarray, w0: np.ndarray) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
+def _validate_inputs(A: np.ndarray, b: np.ndarray, w0: np.ndarray) -> tuple[np.ndarray, np.ndarray, np.ndarray]:
     """Validate and coerce input arrays to ensure they have compatible shapes.
 
     Parameters
@@ -233,7 +232,7 @@ def leximin_weight_fair(
     max_ratio: float = 10.0,
     slack: float = 0.0,
     return_stages: bool = False,
-) -> CalibrationResult | Tuple[CalibrationResult, CalibrationResult]:
+) -> CalibrationResult | tuple[CalibrationResult, CalibrationResult]:
     r"""Compute weights via residual leximin followed by weight-fair refinement.
 
     This function first solves the residual minimisation problem as in
@@ -341,4 +340,4 @@ def leximin_weight_fair(
     stage2 = CalibrationResult(w=w, epsilon=epsilon_opt, t=t_opt, status=res.status, message=res.message)
     if return_stages:
         return stage1, stage2
-    return stage2
+    return stage2

fairlex/calibration.py

@@ -135,7 +135,7 @@ def evaluate_solution(
     # Example: for quantiles (0.99, 0.95, 0.5) we get q_vals[0]=0th?? Actually quantiles appended in order: (0.99, 0.95, 0.5, 0.0, 1.0)
     # We'll map them explicitly.
     # Build a dict for clarity
-    q_map = {q: v for q, v in zip(quantiles + (0.0, 1.0), q_vals)}
+    q_map = dict(zip(quantiles + (0.0, 1.0), q_vals, strict=False))
     weight_max = float(q_map[1.0])
     weight_min = float(q_map[0.0])
     # Sort the requested quantiles for deterministic mapping
@@ -170,4 +170,4 @@ def evaluate_solution(
             p95_rel_dev=float(np.percentile(rel_dev, 95)),
             median_rel_dev=float(np.median(rel_dev)),
         )
-    return result
+    return result