skaal 0.1.0__tar.gz

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

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches: [main, ci]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dev dependencies
+        run: uv sync --group dev
+
+      - uses: pre-commit/action@v3.0.1
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dev dependencies
+        run: uv sync --group dev
+
+      - name: Run tests
+        run: uv run pytest --tb=short -q

skaal-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,107 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: uv sync --group dev
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Verify distributions
+        run: |
+          ls -lh dist/
+          uv pip install twine
+          uv run twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/skaal
+    permissions:
+      id-token: write  # Required for OIDC trusted publishing
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/skaal
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  create-github-release:
+    name: Create GitHub Release
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

skaal-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+env/
+.env
+*.so
+
+# Rust
+target/
+Cargo.lock
+
+# Skaal
+plan.skaal.lock
+*.plan.lock
+artifacts/
+
+# Tools
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# uv
+uv.lock

skaal-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,70 @@
+repos:
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: '^(skaal/deploy/templates/|\.git)'
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: ['--unsafe']
+        exclude: '^skaal/deploy/templates/'
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+        exclude: '^skaal/deploy/templates/'
+      - id: mixed-line-ending
+        args: ['--fix=lf']
+
+  # Python formatting (Ruff)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+        exclude: '^skaal/deploy/templates/'
+      - id: ruff-format
+        stages: [pre-commit]
+        exclude: '^skaal/deploy/templates/'
+
+  # Type checking (MyPy)
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pydantic>=2.0
+          - pydantic-settings>=2.0
+          - z3-solver>=4.12
+        args: [--ignore-missing-imports]
+        exclude: ^(tests/|examples/|skaal/deploy/templates/)
+
+  # YAML linting
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: [-c, .yamllint]
+        exclude: '^skaal/deploy/templates/|^artifacts/'
+
+  # Security checks
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.5
+    hooks:
+      - id: bandit
+        additional_dependencies: [pbr]
+        args: [--severity-level=medium]
+        exclude: ^(tests/|skaal/deploy/templates/)
+
+ci:
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes for pre-commit hooks
+
+    for more information, see https://pre-commit.ci
+  autofix_prs: true
+  autoupdate_branch: ''
+  autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+  autoupdate_schedule: weekly
+  skip: [mypy]  # MyPy can be slow, skip in CI if desired
+  submodules: false

skaal-0.1.0/.yamllint

@@ -0,0 +1,13 @@
+---
+extends: default
+
+rules:
+  line-length:
+    max: 120
+  indentation:
+    spaces: 2
+  comments:
+    min-spaces-from-content: 2
+  trailing-spaces: disable
+  empty-lines:
+    max: 2

skaal-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,158 @@
+# Contributing to Skaal
+
+Thank you for your interest in contributing to Skaal! This document provides guidelines for contributing to the project.
+
+## Development Setup
+
+### 1. Clone and Install
+
+```bash
+git clone https://github.com/Elouen-ginat/Skaal.git
+cd Skaal
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+# or with uv:
+uv sync --group dev
+```
+
+### 2. Set Up Pre-commit Hooks
+
+Pre-commit hooks ensure code quality before each commit:
+
+**macOS/Linux:**
+```bash
+bash scripts/setup-pre-commit.sh
+```
+
+**Windows:**
+```bash
+scripts\setup-pre-commit.bat
+```
+
+**Manual:**
+```bash
+pre-commit install
+```
+
+See [PRE_COMMIT_SETUP.md](PRE_COMMIT_SETUP.md) for detailed information.
+
+### 3. Verify Setup
+
+```bash
+# Run all hooks on your changes
+pre-commit run --all-files
+
+# Run tests
+pytest
+
+# Type checking
+mypy skaal tests
+
+# Linting
+ruff check skaal tests
+```
+
+## Workflow
+
+1. Create a feature branch: `git checkout -b feature/my-feature`
+2. Make changes (pre-commit hooks will run on commit)
+3. Write tests for new functionality
+4. Run tests: `pytest`
+5. Push and create a Pull Request
+
+## Code Standards
+
+### Python
+
+- Use **ruff** for linting and formatting (automatically enforced by pre-commit)
+- Use **mypy** for static type checking (included in pre-commit)
+- Write unit tests in `tests/` directory
+- Follow PEP 8 style guidelines
+
+### YAML/JSON
+
+- Validate with pre-commit hooks (automatically enforced)
+- Use 2-space indentation
+
+### Commits
+
+- Use descriptive commit messages
+- Reference issues when applicable: "Fixes #123"
+- Pre-commit will auto-fix formatting issues before commit
+
+## Running Tests
+
+```bash
+# All tests
+pytest
+
+# With coverage
+pytest --cov=skaal
+
+# Specific test file
+pytest tests/solver/test_solver.py
+
+# Specific test function
+pytest tests/solver/test_solver.py::test_basic_solver
+```
+
+## Pre-commit Hooks
+
+Hooks run automatically on `git commit` and include:
+- **Ruff**: Python linting & formatting
+- **MyPy**: Type checking
+- **YAML/JSON validators**: Format validation
+- **Trailing whitespace**: Auto-fix
+- **Security checks**: Bandit
+
+To run manually:
+```bash
+pre-commit run --all-files
+```
+
+To skip hooks (not recommended):
+```bash
+git commit --no-verify
+```
+
+## Documentation
+
+- Update [LOCAL_DEPLOYMENT.md](LOCAL_DEPLOYMENT.md) if adding deployment features
+- Update docstrings for public APIs
+- Add type hints to new functions
+
+## Reporting Bugs
+
+Please use GitHub Issues and include:
+- Description of the bug
+- Steps to reproduce
+- Expected behavior
+- Actual behavior
+- OS/Python version info
+
+## Feature Requests
+
+Use GitHub Issues with:
+- Clear description of the feature
+- Why you think it would be useful
+- Possible implementation approach (optional)
+
+## Pull Requests
+
+- Clear PR title and description
+- Link to related issues
+- All tests pass
+- Code passes pre-commit checks
+- Documentation updated if needed
+
+## Questions?
+
+Have questions about contributing? Open an issue or check existing documentation:
+- [PRE_COMMIT_SETUP.md](PRE_COMMIT_SETUP.md) - Pre-commit hook details
+- [LOCAL_DEPLOYMENT.md](LOCAL_DEPLOYMENT.md) - Deployment and testing
+- [pyproject.toml](pyproject.toml) - Project configuration
+
+---
+
+**Thank you for contributing to Skaal!** 🎉

skaal-0.1.0/Cargo.toml

@@ -0,0 +1,8 @@
+[workspace]
+members = ["mesh"]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+license = "GPL-3.0-or-later"