geomotif 1.0.0__tar.gz

geomotif-1.0.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Something does not do what it says it does
+labels: bug
+---
+
+**What you did**
+
+The smallest piece of code that shows it. A motif name and its parameters is
+usually enough; a spec file works too.
+
+```python
+
+```
+
+**What happened**
+
+Output, traceback, or the exported file — whichever shows the problem.
+
+**What you expected instead**
+
+**Versions**
+
+- geomotif:
+- Python:
+- OS:
+- matplotlib / scipy, if the problem involves either:

geomotif-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question or idea
+    url: https://github.com/pianosuki/geomotif/discussions
+    about: For anything that is not a bug or a concrete request.

geomotif-1.0.0/.github/ISSUE_TEMPLATE/motif.md

@@ -0,0 +1,30 @@
+---
+name: Motif request
+about: A shape that ought to be in the catalogue
+labels: motif
+---
+
+**The shape**
+
+What it is called, and a link to a description of it — Wikipedia, a paper, a
+picture. If it has a formula, give the formula.
+
+**How it is defined**
+
+This decides which base class it uses, so it is the useful half of the request:
+
+- a radius as a function of angle?
+- one curve from one parameter?
+- a set of corners?
+- a grammar drawn with a turtle?
+- points joined by edges?
+- a cell repeated on a lattice, or tiles that subdivide?
+
+**Parameters**
+
+What should be adjustable, and what a good default would be.
+
+**Anything everyone gets wrong about it**
+
+Optional, and the most valuable part when there is one — a petal count that
+depends on a parity rule, a spiral that is not the spiral people think it is.

geomotif-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+**What this changes, and why**
+
+**Checklist**
+
+- [ ] `make check` passes (ruff, ruff-format, mypy strict, pytest)
+- [ ] Tests cover what is *interesting* about the change, not just its lines
+- [ ] `CHANGELOG.md` has an entry under `[Unreleased]`
+- [ ] `make docs-gen` was run and the result committed, if a motif was added,
+      renamed or re-exampled
+- [ ] The core is still zero-dependency, or the new dependency is behind an
+      extra and declared with `requires=`
+
+See [CONTRIBUTING.md](../CONTRIBUTING.md) for the house style.

geomotif-1.0.0/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+
+updates:
+  # Actions only. The package has no runtime dependencies to update, and the
+  # dev and docs groups are floor-pinned rather than locked, so a bot PR there
+  # would be noise. A pinned action that quietly goes unmaintained is the real
+  # supply-chain risk in this repository.
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      actions:
+        patterns: ["*"]
+    commit-message:
+      prefix: "ci"

geomotif-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,131 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          # Pinned to the supported floor so linting checks against the
+          # oldest interpreter we promise to run on, not the newest.
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: pip install -e . --group dev
+      - run: ruff check --output-format=github .
+      # Belt and braces: fails the build on any syntax newer than the floor,
+      # even if pyproject's target-version is edited by accident.
+      - run: ruff check --target-version py312 --output-format=github .
+      - run: ruff format --check .
+      - run: mypy
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: pip install -e . --group dev
+      - run: pytest
+
+  bare:
+    # The zero-dependency promise, checked rather than asserted: the core
+    # installs and its suite passes with no matplotlib and no scipy. The
+    # tests that need either skip themselves, so a motif family sneaking a
+    # hard dependency in shows up here as a failure, not as a heavier wheel.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: pip install -e . pytest
+      - name: Confirm the optional dependencies really are absent
+        run: |
+          ! pip list --format=freeze | grep -E '^(matplotlib|scipy)=='
+      - run: pytest
+
+  plugin:
+    # The third-party contract, checked rather than asserted: a package that
+    # declares a geomotif.motifs entry point is discovered, described and
+    # rendered by an installation that knows nothing about it. The suite
+    # simulates this; only a real install proves the packaging half.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: pip install -e .
+      # --no-deps deliberately: the plugin depends on a published geomotif,
+      # and what is being tested is this checkout.
+      - run: pip install --no-deps ./examples/plugin
+      - name: The plugin's motif is discovered, described and rendered
+        run: |
+          geomotif list --family curve | grep -q superformula
+          geomotif show superformula | grep -q Gielis
+          geomotif render superformula --m 5 --out sf.svg
+          test -s sf.svg
+
+  docs:
+    # The documentation is generated from the registry, so it can only be wrong
+    # in two ways: the build fails, or the committed half of it -- the
+    # catalogue and the README's images, which GitHub renders without ever
+    # running mkdocs -- has fallen behind. Both are checked here.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      # The extras are installed so that the four scipy motifs render; without
+      # them the gallery would quietly document itself as incomplete.
+      - run: pip install -e '.[all]' --group docs
+      - run: python tools/gendocs.py
+      - name: The committed documentation is current
+        run: |
+          git add --intent-to-add -- docs/catalogue.md docs/assets
+          git diff --exit-code -- docs/catalogue.md docs/assets \
+            || { echo "Run 'make docs-gen' and commit the result."; exit 1; }
+      - run: mkdocs build --strict
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*

geomotif-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Docs
+
+# The site is rebuilt from the code on every push to main. Nothing about it is
+# committed except the catalogue and the README's images, so "deploy" and
+# "regenerate" are the same action and the published pages cannot describe a
+# version of the library that no longer exists.
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# One deployment at a time, and never cancel one that is in flight: a
+# half-published site is worse than a slightly stale one.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      # With the extras, so the four scipy motifs are rendered rather than
+      # documented as unavailable.
+      - run: pip install -e '.[all]' --group docs
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

geomotif-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: Publish
+
+# Tag push publishes to PyPI through trusted publishing: PyPI verifies the
+# workflow's OIDC identity directly, so there is no API token in this
+# repository's secrets to leak, rotate or forget.
+#
+# Configure it once at https://pypi.org/manage/project/geomotif/settings/publishing/
+# with owner `pianosuki`, repository `geomotif`, workflow `publish.yml` and
+# environment `pypi`.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: The tag and the package agree about the version
+        # A tag is easy to push before the bump and impossible to move after
+        # PyPI has accepted the file it names.
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          python - <<'PY'
+          import os, pathlib, re, sys
+          tag = os.environ["GITHUB_REF_NAME"].removeprefix("v")
+          source = pathlib.Path("src/geomotif/__init__.py").read_text()
+          version = re.search(r'^__version__ = "([^"]+)"', source, re.M).group(1)
+          if tag != version:
+              sys.exit(f"tag {tag!r} does not match __version__ {version!r}")
+          print(f"publishing {version}")
+          PY
+
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check --strict dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/geomotif
+    permissions:
+      # The whole point: this is what PyPI checks instead of a token.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

geomotif-1.0.0/.gitignore

@@ -0,0 +1,32 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Environments
+.venv/
+venv/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editors
+.idea/
+.vscode/
+
+# Demo output
+spiral-demo.png
+
+# Documentation regenerated from the code on every build by tools/gendocs.py.
+# docs/catalogue.md and docs/assets/ are deliberately *not* here: GitHub renders
+# the README without running mkdocs, so those two are committed and drift-checked.
+docs/gallery/
+docs/reference/
+site/

geomotif-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v2.3.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["matplotlib>=3.10"]
+        args: []
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-added-large-files