framemill 0.1.1__tar.gz

framemill-0.1.1/.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: pytest -q
+
+  # Build the from-source distribution artifacts (wheel + sdist) on every push so
+  # regressions in packaging metadata surface early. These are the primary release
+  # artifacts; platform binaries are built best-effort in release.yml on a tag.
+  dist:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - run: python -m pip install dist/*.whl && framemill --help
+      - uses: actions/upload-artifact@v4
+        with:
+          name: framemill-dist
+          path: dist/*

framemill-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  # Build the wheel + sdist once and hand them to the later jobs.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - run: python -m pip install dist/*.whl && framemill --help
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  # Attach the wheel + sdist to the GitHub release with generated notes.
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          fail_on_unmatched_files: true
+
+  # Publish to PyPI via Trusted Publishing (OIDC). No stored token.
+  # Requires a PyPI "pending publisher" pointing at this repo, this workflow
+  # file (release.yml), and the "pypi" environment before the first tag.
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  # Self-contained Linux AppImage: bundles a manylinux Python plus framemill.
+  # Best-effort: a failure here does not block the wheel/sdist/PyPI release.
+  appimage:
+    needs: github-release
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build AppImage
+        id: build
+        run: bash packaging/build_appimage.sh
+      - name: Attach AppImage to the release
+        if: steps.build.outcome == 'success'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*.AppImage

framemill-0.1.1/.gitignore

@@ -0,0 +1,54 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+env/
+
+# Flet / Flutter build output
+build/
+*.app/
+*.AppImage
+*.dmg
+*.msi
+
+# Test / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Local runtime data (never commit user paths / config)
+*.log
+/tmp_render/
+scratch/
+sample_models/
+
+# Source models (inputs only, never repo content) and rendered/demo output.
+# Guards against committing game assets or generated sprite sheets.
+*.fbx
+*.glb
+*.gltf
+*.obj
+*.tga
+*.bmp
+/*.png
+/renders/
+/out/
+
+# Private local orchestration and environment data
+.archon/
+.env
+.env.*
+!.env.example
+.ruff_cache/
+*.recipe.json

framemill-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Thanks for your interest in framemill!
+
+## Dev setup (project-local virtualenv)
+
+framemill's Python dependencies live in a **per-project virtualenv**. They are
+not installed system-wide. Nothing here needs to be registered with your OS
+package manager; `pyproject.toml` is the source of truth for dependencies.
+
+```bash
+python3 -m venv .venv
+. .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"     # framemill + Flet, Pillow, NumPy, pytest, ruff
+
+framemill                    # launch the GUI
+pytest -q                    # unit tests (no Blender needed)
+ruff check .
+```
+
+Blender is **not** a pip dependency. Install it separately from
+[blender.org](https://www.blender.org/download/). framemill auto-detects it.
+
+## Testing changes that touch rendering
+
+Compositing, export, direction layout, preview settings, sampling, recipes,
+validation and framing helpers have Blender-free tests. Sampling tests use
+doubles; they do not validate Blender's actual mesh deformation, materials or
+camera output. Changes to `framemill/blender/render_sprites.py` need a manual
+check against a real model. Please note in your PR which Blender version and
+model you tested with.
+
+## Scope
+
+framemill aims to stay a focused "model -> directional sprite sheet" tool.
+Engine-specific export quirks are welcome as optional formats; please keep
+defaults neutral so the tool works for any model out of the box.