shapemesh 0.1.0__tar.gz

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

@@ -0,0 +1,249 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+env:
+  UV_VERSION: "0.13.5"
+
+jobs:
+  quality:
+    name: Lint, format, and type check
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    env:
+      UV_PYTHON: "3.13"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: "3.13"
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Install dependencies
+        run: uv sync --locked --python 3.13
+
+      - name: Check lockfile
+        run: uv lock --check
+
+      - name: Lint
+        run: uv run --no-sync ruff check .
+
+      - name: Check formatting
+        run: uv run --no-sync ruff format --check .
+
+      - name: Type check
+        run: uv run --no-sync pyright
+
+  test:
+    name: Test (${{ matrix.os }}, Python ${{ matrix.python-version }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 20
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          - "3.15"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install Gmsh system libraries (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install --yes --no-install-recommends \
+            libglu1-mesa libgl1 libxrender1 libxcursor1 libxft2 \
+            libxinerama1 libfontconfig1
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Install dependencies
+        run: uv sync --locked --python ${{ matrix.python-version }}
+
+      - name: Verify Gmsh version
+        run: uv run --no-sync python -c "import gmsh; assert gmsh.__version__ == '4.15.2', gmsh.__version__"
+
+      - name: Run tests
+        run: uv run --no-sync pytest -q -W error
+
+  package:
+    name: Build and verify distributions
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    env:
+      UV_PYTHON: "3.13"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install Gmsh system libraries (Linux)
+        run: |
+          sudo apt-get update
+          sudo apt-get install --yes --no-install-recommends \
+            libglu1-mesa libgl1 libxrender1 libxcursor1 libxft2 \
+            libxinerama1 libfontconfig1
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: "3.13"
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Install dependencies
+        run: uv sync --locked --python 3.13
+
+      - name: Build distributions
+        run: |
+          rm -rf dist
+          uv build
+
+      - name: Check distribution metadata
+        run: uvx twine check --strict dist/*
+
+      - name: Verify distribution contents
+        run: |
+          uv run --no-sync python - <<'PY'
+          import pathlib
+          import tarfile
+          import zipfile
+
+          dist = pathlib.Path("dist")
+          wheels = sorted(dist.glob("*.whl"))
+          sdists = sorted(dist.glob("*.tar.gz"))
+          assert len(wheels) == 1, wheels
+          assert len(sdists) == 1, sdists
+          wheel, sdist = wheels[0], sdists[0]
+
+          required_wheel = {
+              "shapemesh/__init__.py",
+              "shapemesh/builder.py",
+              "shapemesh/constants.py",
+              "shapemesh/errors.py",
+              "shapemesh/mesh.py",
+              "shapemesh/py.typed",
+              "shapemesh/settings.py",
+              "shapemesh/shapes.py",
+          }
+
+          with zipfile.ZipFile(wheel) as archive:
+              wheel_entries = {info.filename: info for info in archive.infolist()}
+
+          missing = required_wheel - wheel_entries.keys()
+          assert not missing, f"{wheel.name} is missing {sorted(missing)}"
+          for license_name in ("COPYING", "COPYING.LESSER"):
+              matches = [
+                  info
+                  for name, info in wheel_entries.items()
+                  if name.endswith(f"dist-info/licenses/{license_name}")
+              ]
+              assert matches, f"{wheel.name} is missing {license_name}"
+              assert all(info.file_size > 0 for info in matches)
+
+          required_sdist = {
+              "COPYING",
+              "COPYING.LESSER",
+              "README.md",
+              "pyproject.toml",
+              "examples/beam_with_hole.py",
+              "examples/frame.py",
+              "examples/pilecap.py",
+              "src/shapemesh/py.typed",
+          }
+
+          with tarfile.open(sdist) as archive:
+              sdist_entries = {member.name: member for member in archive.getmembers()}
+
+          for suffix in required_sdist:
+              matches = [
+                  member
+                  for name, member in sdist_entries.items()
+                  if name == suffix or name.endswith(f"/{suffix}")
+              ]
+              assert matches, f"{sdist.name} is missing {suffix}"
+              if suffix != "src/shapemesh/py.typed":
+                  assert all(member.size > 0 for member in matches)
+
+          print(f"{wheel.name}: {len(wheel_entries)} entries")
+          print(f"{sdist.name}: {len(sdist_entries)} entries")
+          PY
+
+      - name: Install the built wheel
+        run: uv pip install --python .venv/bin/python --no-deps --force-reinstall dist/*.whl
+
+      - name: Verify the installed wheel
+        run: |
+          uv run --no-sync python - <<'PY'
+          import pathlib
+
+          import shapemesh
+
+          path = pathlib.Path(shapemesh.__file__).resolve()
+          assert "site-packages" in path.parts, f"imported the source tree instead: {path}"
+          print(f"Imported shapemesh {shapemesh.__version__} from {path}")
+          PY
+
+      - name: Run tests against the installed wheel
+        run: uv run --no-sync pytest -q -W error
+
+      - name: Smoke-test the examples
+        working-directory: ${{ runner.temp }}
+        run: |
+          set -euo pipefail
+          for example in "$GITHUB_WORKSPACE"/examples/*.py; do
+            echo "::group::$(basename "$example")"
+            "$GITHUB_WORKSPACE/.venv/bin/python" "$example"
+            echo "::endgroup::"
+          done
+          test -s beam_with_hole.msh
+          test -s frame.msh
+          test -s pilecap.msh
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: distributions
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7

shapemesh-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# Byte-compiled / optimized / cache files
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Editor settings
+.vscode/settings.json
+
+# Output files
+*.msh

shapemesh-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

shapemesh-0.1.0/AGENTS.md

@@ -0,0 +1,122 @@
+# AGENTS.md
+
+Guidance for contributors and AI agents working in this repository.
+
+## Design
+
+The source of truth for the current scope is `design-v1.md`. Keep it up
+to date as you implement within its scope.
+
+## License
+
+The project is LGPL-3.0-or-later. The license is split across two files because
+the LGPL is the GPL plus additional permissions:
+
+- `COPYING` — the GNU GPL-3.0 text.
+- `COPYING.LESSER` — the LGPL-3.0 supplement.
+
+Every new source file must start with the full notice below (copyright holder:
+Mads Kruse). Files under `examples/` may instead use the short notice shown
+after it, so documentation-focused examples stay concise:
+
+```text
+# Copyright (C) 2026 Mads Kruse
+#
+# This file is part of shapemesh.
+#
+# shapemesh is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# shapemesh is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with shapemesh. If not, see <https://www.gnu.org/licenses/>.
+```
+
+The permitted short form for files under `examples/` is:
+
+```text
+# Copyright (C) 2026 Mads Kruse
+# SPDX-License-Identifier: LGPL-3.0-or-later
+```
+
+## Docstrings
+
+Public API docstrings use **Google style**:
+
+- A one-line summary, then a blank line, then sections.
+- Sections are ``Args:``, ``Returns:`` (or ``Yields:``), ``Raises:``, and
+  ``Examples:``. Each entry is ``name: description``, indented 4 spaces, with
+  continuation lines indented to align under the description.
+- Omit the type in ``Args``/``Returns`` when the signature already annotates it.
+- Cross-reference project objects with single backticks (`` `Mesh` ``) and
+  inline code with double backticks (`` ``.msh`` ``). Do not use Sphinx roles
+  (``:class:``, ``:meth:``, ``:func:``).
+- Document every public class, function, method, and property. Include a
+  ``Raises:`` section whenever it can raise.
+
+```python
+def build(shapes, settings):
+    """Realize ``shapes`` with Gmsh and return the resulting `Mesh`.
+
+    Args:
+        shapes: A shape or a sequence of shapes to mesh.
+        settings: The mesh settings.
+
+    Returns:
+        The entity-classified mesh.
+
+    Raises:
+        BuildError: If a Gmsh call fails.
+    """
+```
+
+## Commit messages
+
+We follow the spirit of [Common Changelog](https://common-changelog.org/):
+commits and changelogs are written for humans, not machines.
+
+- Write the subject in the **past tense, active voice**, leading with a verb:
+  `Added ...`, `Fixed ...`, `Refactored ...`, `Removed ...`, `Documented ...`,
+  `Bumped ...`.
+- Capitalize the first word; no trailing period.
+- Do **not** use Conventional Commits prefixes (`feat:`, `fix:`, `chore:`).
+- Keep the subject to a single line; put the "why" and detail in the body.
+- Lead with `Breaking:` when a change is breaking.
+
+## Remote pushes
+
+Never push commits, tags, or branches to a remote without explicit approval.
+Prepare the commit locally, show it for review, and wait for the user to approve
+the push. Approval applies only to the reviewed changes. Do not rewrite
+published history or force-push without separate explicit approval.
+
+## Changelog
+
+`CHANGELOG.md` follows [Common Changelog](https://common-changelog.org/) and is
+updated when a release is prepared, not with every commit. Do not add an
+`Unreleased` section.
+
+- Start each release with `## [VERSION] - YYYY-MM-DD` and link the version to
+  its GitHub release with a reference-style link at the bottom of the file.
+- Add a one-sentence italic notice when useful. First releases use
+  `_First release._`.
+- Group changes under `### Changed`, `### Added`, `### Removed`, and
+  `### Fixed`, in that order, and omit empty groups.
+- Write each change in the imperative mood on one line, starting with a verb
+  such as `Add`, `Fix`, `Remove`, or `Refactor`.
+- End each change with one or more Markdown links to the most relevant commits,
+  for example
+  ``([`53bd922`](https://github.com/MEMAndersen/shapemesh/commit/53bd922))``.
+- Add the author after the references, for example `(Mads Kruse)`.
+- Follow [3.4. Merge related changes](https://common-changelog.org/#34-merge-related-changes):
+  merge commits that implement one change and leave out maintenance that does
+  not affect users. Keep the list short.
+- Prefix breaking changes with `**Breaking:**` and list them first.
+- Keep releases latest-first, and tag each release with the same version
+  (`vX.Y.Z`).

shapemesh-0.1.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [0.1.0] - 2026-10-27
+
+_First release._
+
+### Added
+
+- Add 12 shape primitives and n-ary `Union`, `Intersection`, and `Difference` with operator overloads ([`821888c`](https://github.com/MEMAndersen/shapemesh/commit/821888c), [`f315cf6`](https://github.com/MEMAndersen/shapemesh/commit/f315cf6)) (Mads Kruse)
+- Add `build()` with label-preserving physical groups and `MeshSettings` for element size, element order, 2D and 3D algorithms, and advanced Gmsh options ([`821888c`](https://github.com/MEMAndersen/shapemesh/commit/821888c), [`647c5e5`](https://github.com/MEMAndersen/shapemesh/commit/647c5e5)) (Mads Kruse)
+- Add MSH 4.1 ASCII I/O and the `Mesh` query and NumPy API ([`41efc2b`](https://github.com/MEMAndersen/shapemesh/commit/41efc2b), [`d02d866`](https://github.com/MEMAndersen/shapemesh/commit/d02d866)) (Mads Kruse)
+- Add a typed public API with `py.typed` and a structured exception hierarchy ([`821888c`](https://github.com/MEMAndersen/shapemesh/commit/821888c), [`4e30f0e`](https://github.com/MEMAndersen/shapemesh/commit/4e30f0e)) (Mads Kruse)
+- Add 1D, 2D, and 3D examples and documentation for labels, threading, and the Gmsh version policy ([`cde6dc0`](https://github.com/MEMAndersen/shapemesh/commit/cde6dc0), [`413dc02`](https://github.com/MEMAndersen/shapemesh/commit/413dc02)) (Mads Kruse)
+- Support Python 3.12 through 3.15 on Linux, macOS, and Windows with Gmsh 4.0 or later ([`4f941e1`](https://github.com/MEMAndersen/shapemesh/commit/4f941e1), [`b605815`](https://github.com/MEMAndersen/shapemesh/commit/b605815)) (Mads Kruse)
+
+[0.1.0]: https://github.com/MEMAndersen/shapemesh/releases/tag/v0.1.0