platenest 0.1.0__tar.gz

platenest-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

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

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+  workflow_dispatch:
+  # the release workflow runs all of this again on the tag before it publishes anything
+  workflow_call:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/') }}
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check .
+      - run: ruff format --check .
+      - run: pytest -q
+
+  build:
+    needs: test
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check --strict dist/*
+      - name: The wheel installs and imports on its own
+        run: |
+          python -m venv /tmp/clean
+          /tmp/clean/bin/pip install -q dist/*.whl
+          cp tools/smoke.py /tmp/smoke.py
+          cd /tmp && /tmp/clean/bin/python smoke.py
+      - run: cd dist && sha256sum * > SHA256SUMS && cat SHA256SUMS
+      - uses: actions/upload-artifact@v7
+        with:
+          name: platenest-dist
+          path: dist/
+          if-no-files-found: error

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

@@ -0,0 +1,97 @@
+name: Release
+
+# A pushed `v<version>` tag publishes that version to GitHub and to PyPI:
+#
+#   v0.2.0b1 / v0.2.0rc1  pre-release, from dev (or main), titled "platenest v0.2.0b1 (pre-release)"
+#   v0.2.0                stable, only from a commit on main, titled "platenest v0.2.0", marked latest
+#
+# Before anything is published: the whole CI (lint, tests on two OSes, the built packages), the tag equals
+# `v` + project.version, and CHANGELOG.md has a non-empty `## [<version>]` section, which becomes the release notes.
+# Tags are never moved or deleted: a broken release is followed by the next version, not replaced.
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  checks:
+    uses: ./.github/workflows/ci.yml
+
+  prepare:
+    needs: checks
+    runs-on: ubuntu-24.04
+    outputs:
+      title: ${{ steps.prep.outputs.title }}
+      prerelease: ${{ steps.prep.outputs.prerelease }}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0 # the branch history, to prove a stable tag is on main
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - name: Check the tag and write the notes
+        id: prep
+        run: python tools/release.py prepare --tag "$GITHUB_REF_NAME" --notes notes.md >> "$GITHUB_OUTPUT"
+      - name: A stable release is cut from main
+        if: steps.prep.outputs.prerelease == 'false'
+        run: |
+          if ! git merge-base --is-ancestor "$GITHUB_SHA" origin/main; then
+            echo "::error::$GITHUB_REF_NAME is a stable version but its commit is not on main"
+            exit 1
+          fi
+      - uses: actions/upload-artifact@v7
+        with:
+          name: release-notes
+          path: notes.md
+          if-no-files-found: error
+
+  # PyPI first: a version can be uploaded there only once, so if it refuses, no GitHub release claims it exists.
+  # Trusted publishing (OIDC): no API token anywhere. PyPI must know this repository, this workflow file and the
+  # "pypi" environment as the publisher of the project — configured once on pypi.org.
+  publish-pypi:
+    needs: prepare
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/platenest/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: platenest-dist
+          path: dist
+      - run: rm -f dist/SHA256SUMS
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: [prepare, publish-pypi]
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write # create the release and attach its files
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: platenest-dist
+          path: dist
+      - uses: actions/download-artifact@v8
+        with:
+          name: release-notes
+          path: .
+      - name: Publish
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TITLE: ${{ needs.prepare.outputs.title }}
+          PRERELEASE: ${{ needs.prepare.outputs.prerelease }}
+        run: |
+          (cd dist && sha256sum -c SHA256SUMS)
+          if [ "$PRERELEASE" = "true" ]; then kind=(--prerelease --latest=false); else kind=(--latest); fi
+          gh release create "$GITHUB_REF_NAME" dist/* --repo "$GITHUB_REPOSITORY" \
+            --verify-tag --title "$TITLE" --notes-file notes.md "${kind[@]}"

platenest-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+.superpowers/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.ruff_cache/

platenest-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-13
+
+The first release.
+
+- **The packer** (`from platenest import pack`). Parts are placed by their real top-down outline, so a small part
+  goes into the hole of a frame, the mouth of a U or between the arms of a bracket. You give meshes, quantities, a
+  work zone (plate size, areas parts may or may not be in, a maximum height) and a spacing; you get a plate index,
+  an offset and a rotation for every copy. Six combinations of ordering and direction are tried and the one with the
+  fewest plates is kept.
+- **The spacing you ask for is the least you get** between any two parts, measured on the real outlines; half of it
+  is kept to the edge of the work zone and to excluded areas.
+- **Fill mode**: a part marked `fill` gets a plate of its own with as many copies as fit, and the result says how
+  many that was.
+- **Nothing is dropped silently.** A part with no top-down area, one taller than the zone allows or one too large
+  for an empty plate comes back in `rejected` with its reason, and the rest is still packed. A mesh in the wrong
+  units is refused at once instead of being rasterised first.
+- The group on each plate can be centred in the work zone; a callback reports progress, another cancels a run;
+  `render_plate` draws a top view of a plate.
+- **`platenest.bambu3mf`**, a separate module that needs only the standard library: `write_project` turns meshes,
+  placements and your own project settings into a multi-plate Bambu Studio / OrcaSlicer project 3MF that slices
+  without anything being re-arranged, and `read_project` reads such a file back. A file that is not one of ours,
+  is damaged, or unpacks larger than a limit you set is a `ValueError`.
+- The same input gives the same placements and a byte-identical 3MF.
+- No printer or slicer data is bundled: the work zone and the settings are always yours.

platenest-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+## Branches
+
+- `dev` — where work lands. Branch from `dev` and open pull requests against `dev`.
+- `main` — released code only; it moves forward from `dev` when a stable version is released.
+
+## Before a pull request
+
+```bash
+pip install -e ".[dev]"
+ruff check . && ruff format --check .
+pytest
+```
+
+- The packer depends on `numpy` and `opencv-python-headless` and nothing else; `platenest.bambu3mf` on the standard
+  library only. Tests pin both.
+- No printer or slicer data goes into the package: work zones and settings are the caller's.
+- The implementation is original. Do not port code from other packers; several are under licences this project
+  cannot take.
+- Test fixtures are generated in code. Do not commit model files.
+- A behaviour change comes with a test that fails without it and a line in `CHANGELOG.md` under `[Unreleased]`.
+- Conventional commits: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`.
+
+## Releases
+
+Versions are `X.Y.Z` for stable releases and `X.Y.ZaN` / `X.Y.ZbN` / `X.Y.ZrcN` for pre-releases.
+
+1. Set `version` in `pyproject.toml` and rename `[Unreleased]` in `CHANGELOG.md` to `## [<version>] - <date>`
+   (leave a new empty `[Unreleased]` above it).
+2. Merge to `dev`, wait for CI to be green there. For a stable version, fast-forward `main` to `dev`.
+3. Tag that commit `v<version>` and push the tag.
+
+The tag runs `.github/workflows/release.yml`: the whole CI again, then `tools/release.py` checks that the tag equals
+the package version and that the changelog has a section for it, a stable tag must be on `main`, and only then the
+wheel and the source archive are attached to a GitHub release and published to PyPI through trusted publishing — no
+token is stored anywhere. Tags are never moved or deleted: a broken release is followed by the next version.