parch 0.1.0__tar.gz

parch-0.1.0/.github/dependabot.yml

@@ -0,0 +1,22 @@
+# Dependabot: GitHub Actions and uv (pyproject.toml + uv.lock)
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    groups:
+      python:
+        patterns:
+          - "*"

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

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+      - name: Install poppler-utils
+        run: sudo apt-get update && sudo apt-get install -y poppler-utils
+      - run: uv sync --group dev
+      - run: uv run pytest
+      - name: Generate Nomad PDF
+        run: |
+          uv run parch generate supernote-nomad -w out/nomad
+          test -s out/nomad/index.pdf

parch-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,68 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Publish target"
+        required: true
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: false
+      - run: uv build
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        with:
+          name: dist
+          path: dist/
+
+  pypi:
+    needs: build
+    if: github.event_name == 'push' || inputs.target == 'pypi'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/parch
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+
+  testpypi:
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi'
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/parch
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          repository-url: https://test.pypi.org/legacy/

parch-0.1.0/.github/workflows/readme-previews.yml

@@ -0,0 +1,54 @@
+name: README preview SVGs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - "src/**"
+      - "src/parch/data/configs/158x210-mos-left.toml"
+
+concurrency:
+  group: readme-previews
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  regen:
+    if: github.actor != 'github-actions[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --group dev
+      - name: Regenerate 158×210 sample SVGs
+        run: uv run parch preview-svg 158x210-mos-left --samples
+      - name: Open a PR when SVGs changed
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git add docs/samples/158x210-mos-left
+          if git diff --cached --quiet; then
+            echo "preview SVGs unchanged"
+            exit 0
+          fi
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git switch -C chore/readme-preview-svgs
+          git commit -m "Regenerate 158×210 README preview SVGs."
+          git push --force-with-lease origin chore/readme-preview-svgs
+          existing="$(gh pr list --head chore/readme-preview-svgs --state open --json number --jq '.[0].number // empty')"
+          if [ -n "$existing" ]; then
+            echo "updated PR #$existing"
+            exit 0
+          fi
+          gh pr create --base master --head chore/readme-preview-svgs \
+            --title "Regenerate 158×210 README preview SVGs" \
+            --body "$(cat <<'EOF'
+          Bot-generated Typst preview SVGs for the README. Merge after CI passes.
+
+          This PR is opened instead of pushing to master so the required \`test\` check can run.
+          EOF
+          )"

parch-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv
+out/
+.tools/
+__pycache__/
+*.pyc
+.pytest_cache
+dist
+*.egg-info
+.ruff_cache
+.mypy_cache

parch-0.1.0/LICENSE

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 PDF Planner Project
+Copyright (c) 2026 Vitaliy Kudryk (original LYP)
+
+This software is a Python port of Vitaliy Kudryk's LYP (latex yearly planner),
+originally licensed under the MIT License (2026).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

parch-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.5
+Name: parch
+Version: 0.1.0
+Summary: parch -- pages for e-ink.
+Project-URL: Homepage, https://github.com/yyolk/parch
+Project-URL: Repository, https://github.com/yyolk/parch
+Project-URL: Issues, https://github.com/yyolk/parch/issues
+Author-email: Joseph Chiocchi <joe@yolk.cc>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2026 PDF Planner Project
+        Copyright (c) 2026 Vitaliy Kudryk (original LYP)
+        
+        This software is a Python port of Vitaliy Kudryk's LYP (latex yearly planner),
+        originally licensed under the MIT License (2026).
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+License-File: LICENSE
+Keywords: e-ink,planner,supernote,typst
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Printing
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: questionary
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# parch
+
+**Parch** generates yearly planner PDFs for e-ink devices. Python port of Vitaliy Kudryk’s LYP: read a device profile, emit Typst, compile to PDF.
+
+Formerly eink-planner.
+
+This is a port of [Vitaliy Kudryk's LYP (latex-yearly-planner)](https://github.com/kudrykv/latex-yearly-planner/tree/alpha) ([fork point commit](https://github.com/kudrykv/latex-yearly-planner/commit/a59229770cfbf4a05b68a656dd70c02913a7df49), MIT, 2026). LYP generates a yearly planner by emitting **Typst**, then compiling that to **PDF**. This package keeps that architecture: Python reads a **TOML** device profile, walks calendar entities, and writes `index.typst` + `index.pdf`. It does **not** draw PDFs with reportlab/fpdf.
+
+Default device is the **SuperNote Nomad** (A6 X2), MOS strip on the left. A Nomad MOS-right sibling, Kindle Scribe, and 158×210 MOS-left/MOS-right profiles are also shipped.
+
+## Install
+
+Needs [uv](https://docs.astral.sh/uv/) and Python 3.12+.
+
+```shell
+uv tool install parch
+parch generate supernote-nomad
+```
+
+`typst` is used to compile the PDF. If it is not on `PATH`, the compile step downloads the official Typst v0.15.1 binary for the current OS/arch into `.tools/typst` (`.tools/typst.exe` on Windows).
+
+## Generate
+
+```shell
+# SuperNote Nomad 2026 (default profile, MOS-left) → ./out/index.pdf
+uv run parch generate supernote-nomad
+
+# SuperNote Nomad 2027 from the shipped 2026 profile (CLI overlay)
+uv run parch generate supernote-nomad --year 2027
+
+# SuperNote Nomad MOS-right → ./out/nomad-mos-right/index.pdf
+uv run parch generate supernote-nomad-mos-right -w out/nomad-mos-right
+
+# 158×210 MOS-left → ./out/mos-left/index.pdf
+uv run parch generate 158x210-mos-left -w out/mos-left
+
+# 158×210 MOS-left lined → ./out/mos-left-lined/index.pdf
+uv run parch generate 158x210-mos-left-lined -w out/mos-left-lined
+
+# 158×210 MOS-right → ./out/mos-right/index.pdf
+uv run parch generate 158x210-mos-right -w out/mos-right
+
+# Kindle Scribe → ./out/scribe/index.pdf
+uv run parch generate kindle-scribe -w out/scribe
+```
+
+Flags:
+
+| Flag | Default | Meaning |
+| --- | --- | --- |
+| `-w` / `--workdir` | `./out` | Where `index.typst` and `index.pdf` are written |
+| `-l` / `--locale` | `en` | Locale code |
+| `-g` / `--with-ghostscript` | off | Optional PDF shrink via `gs` |
+| `--debug` | off | Draw MOS debug strokes (not a config key) |
+| `--year` | file year | Overlay planner year (dates and cover title; not a config key) |
+
+`--year` also rewrites the cover title year when the old year is in the title.
+
+Copy a shipped profile to start a new year or trim sections:
+
+```shell
+uv run parch new --from supernote-nomad --year 2027 --yes -o mine.toml
+```
+
+`parch new` without `--yes` asks for starting profile, year, sections, and output path. Locale stays `parch generate -l`.
+
+A name in the top-level `sections = ["cover", …]` list is enabled, in that order. Comment a name out of `sections` to disable it. Details live under `[section.<name>]`. There is no `enabled = true` flag, and `debug` does not belong in the profile — use `parch generate --debug`. At least one section must remain.
+
+## Sample pages
+
+2026 from [`158x210-mos-left`](src/parch/data/configs/158x210-mos-left.toml). MOS strip on the left. This profile ships cover, Contents, the calendar sections, and the colophon (no projects, habits, review, tasks, or meetings). Previews are Typst SVGs at half scale. Regenerate with:
+
+```shell
+uv run parch preview-svg 158x210-mos-left --samples
+```
+
+| Section | Page |
+| --- | --- |
+| Cover | <img src="docs/samples/158x210-mos-left/cover.svg" alt="Cover" width="224" /> |
+| Contents | <img src="docs/samples/158x210-mos-left/contents.svg" alt="Contents" width="224" /> |
+| Annual | <img src="docs/samples/158x210-mos-left/annual.svg" alt="Annual" width="224" /> |
+| Quarterly | <img src="docs/samples/158x210-mos-left/quarterly-q1.svg" alt="Quarterly" width="224" /> |
+| Monthly | <img src="docs/samples/158x210-mos-left/monthly-jan.svg" alt="Monthly" width="224" /> |
+| Weekly | <img src="docs/samples/158x210-mos-left/weekly-w01.svg" alt="Weekly" width="224" /> |
+| Daily | <img src="docs/samples/158x210-mos-left/daily-jan1.svg" alt="Daily" width="224" /> |
+| Daily notes | <img src="docs/samples/158x210-mos-left/notes-jan1.svg" alt="Daily notes" width="224" /> |
+| Colophon | <img src="docs/samples/158x210-mos-left/colophon.svg" alt="Colophon" width="224" /> |
+
+## Device profiles
+
+Sizes are 1:1 on glass at 300 PPI.
+
+| Device | Pixels | Page (pt) | Page (mm) | Config |
+| --- | --- | --- | --- | --- |
+| SuperNote Nomad (A6 X2) | 1404×1872 | 336.96×449.28 | 118.87×158.5 | `supernote-nomad` |
+| SuperNote Nomad MOS-right | 1404×1872 | 336.96×449.28 | 118.87×158.5 | `supernote-nomad-mos-right` |
+| 158×210 MOS-left | — | 447.87×595.28 | 158×210 | `158x210-mos-left` |
+| 158×210 MOS-left lined | — | 447.87×595.28 | 158×210 | `158x210-mos-left-lined` |
+| 158×210 MOS-right | — | 447.87×595.28 | 158×210 | `158x210-mos-right` |
+| Kindle Scribe | 1860×2480 | 446.4×595.2 | 157.48×209.97 | `kindle-scribe` |
+
+Presets also live in `parch.devices`. The Nomad profile scales strokes, type, and gutters down slightly from the original 158×210 MOS-left gist so the MOS layout still fits the smaller page.
+
+**MOS** is Months on the Side — the navigation style that places a vertical month menu on the side of the page (as opposed to a top breadcrumb trail).
+
+Shipped configs keep the **MOS** (Months on the Side) layout: side menu on the physical left except 158×210 MOS-right and SuperNote Nomad MOS-right (physical right), reversed months/quarters, Monday week start, daily schedule 8–20, 5 priorities, 2 extra daily note pages, dotted scratch pad on most shipped configs (the 158×210 MOS-left lined sibling uses `scratch_pad = "lined"` under `[style]` with daily on-page notes still dotted). `pattern` is per notes area (dotted default; `lined` is the other option). MOS-left/MOS-right names are the physical MOS strip side (nav left / nav right), not which hand you write with. MOS-left is the right-handed writing layout (nav opposite the writing hand); MOS-right is the left-handed writing layout.
+
+Device profiles and locale files are TOML. Config keys use underscores (`week_starts`, `side_menu`, `daily_notes`); filenames may still use hyphens (`supernote-nomad.toml`).
+
+## Development
+
+```shell
+cd parch
+uv sync
+```
+
+## Tests
+
+```shell
+uv run pytest
+```
+
+CI runs pytest and a Nomad `parch generate`. Visual design checks live in `tests/visual.py` and can be dropped with the tests that import them.
+
+## Layout of a generated planner
+
+Enabled MOS (Months on the Side) sections, in order:
+
+1. Cover
+2. Annual (12 little calendars)
+3. Quarterly
+4. Monthly
+5. Weekly
+6. Daily (schedule + little calendar + priorities + notes)
+7. Daily notes (extra dotted pages)
+8. Projects (index of write-in names + one kanban board per project)
+9. Habits (index of 12 months + one habit-tracker grid per month)
+10. Review (index of weeks + one lined leftover-notes page per week; no MOS)
+11. Meetings (index of write-in names + one lined page per meeting)
+12. Colophon (quiet About page)
+
+`[section.projects]` takes optional `pages` (default 16) and `card_rows` (default 5). Only Nomad ships projects enabled.
+`[section.habits]` takes optional `habit_columns` (default 6) and `names` (default `[]`; first N header slots are typeset, the rest stay write-in). Enabled on both Nomad profiles.
+`[section.review]` takes optional `weeks_per_page` (default 13). The week field is lined by default and can be `pattern = "dotted"`. Listing `review` without a table uses those defaults. Enabled on both Nomad profiles after Habits.
+`[section.meetings]` takes optional `index_pages` (default 1). Enabled on Nomad after Review.
+
+Internal PDF links use Typst `#padded_link` / `<label>` the same way LYP does. A link is only emitted when the target page exists; otherwise the cell stays plain text.
+
+## License
+
+MIT. This is a port of Vitaliy Kudryk's LYP (MIT 2026). See `LICENSE`.

parch-0.1.0/README.md

@@ -0,0 +1,151 @@
+# parch
+
+**Parch** generates yearly planner PDFs for e-ink devices. Python port of Vitaliy Kudryk’s LYP: read a device profile, emit Typst, compile to PDF.
+
+Formerly eink-planner.
+
+This is a port of [Vitaliy Kudryk's LYP (latex-yearly-planner)](https://github.com/kudrykv/latex-yearly-planner/tree/alpha) ([fork point commit](https://github.com/kudrykv/latex-yearly-planner/commit/a59229770cfbf4a05b68a656dd70c02913a7df49), MIT, 2026). LYP generates a yearly planner by emitting **Typst**, then compiling that to **PDF**. This package keeps that architecture: Python reads a **TOML** device profile, walks calendar entities, and writes `index.typst` + `index.pdf`. It does **not** draw PDFs with reportlab/fpdf.
+
+Default device is the **SuperNote Nomad** (A6 X2), MOS strip on the left. A Nomad MOS-right sibling, Kindle Scribe, and 158×210 MOS-left/MOS-right profiles are also shipped.
+
+## Install
+
+Needs [uv](https://docs.astral.sh/uv/) and Python 3.12+.
+
+```shell
+uv tool install parch
+parch generate supernote-nomad
+```
+
+`typst` is used to compile the PDF. If it is not on `PATH`, the compile step downloads the official Typst v0.15.1 binary for the current OS/arch into `.tools/typst` (`.tools/typst.exe` on Windows).
+
+## Generate
+
+```shell
+# SuperNote Nomad 2026 (default profile, MOS-left) → ./out/index.pdf
+uv run parch generate supernote-nomad
+
+# SuperNote Nomad 2027 from the shipped 2026 profile (CLI overlay)
+uv run parch generate supernote-nomad --year 2027
+
+# SuperNote Nomad MOS-right → ./out/nomad-mos-right/index.pdf
+uv run parch generate supernote-nomad-mos-right -w out/nomad-mos-right
+
+# 158×210 MOS-left → ./out/mos-left/index.pdf
+uv run parch generate 158x210-mos-left -w out/mos-left
+
+# 158×210 MOS-left lined → ./out/mos-left-lined/index.pdf
+uv run parch generate 158x210-mos-left-lined -w out/mos-left-lined
+
+# 158×210 MOS-right → ./out/mos-right/index.pdf
+uv run parch generate 158x210-mos-right -w out/mos-right
+
+# Kindle Scribe → ./out/scribe/index.pdf
+uv run parch generate kindle-scribe -w out/scribe
+```
+
+Flags:
+
+| Flag | Default | Meaning |
+| --- | --- | --- |
+| `-w` / `--workdir` | `./out` | Where `index.typst` and `index.pdf` are written |
+| `-l` / `--locale` | `en` | Locale code |
+| `-g` / `--with-ghostscript` | off | Optional PDF shrink via `gs` |
+| `--debug` | off | Draw MOS debug strokes (not a config key) |
+| `--year` | file year | Overlay planner year (dates and cover title; not a config key) |
+
+`--year` also rewrites the cover title year when the old year is in the title.
+
+Copy a shipped profile to start a new year or trim sections:
+
+```shell
+uv run parch new --from supernote-nomad --year 2027 --yes -o mine.toml
+```
+
+`parch new` without `--yes` asks for starting profile, year, sections, and output path. Locale stays `parch generate -l`.
+
+A name in the top-level `sections = ["cover", …]` list is enabled, in that order. Comment a name out of `sections` to disable it. Details live under `[section.<name>]`. There is no `enabled = true` flag, and `debug` does not belong in the profile — use `parch generate --debug`. At least one section must remain.
+
+## Sample pages
+
+2026 from [`158x210-mos-left`](src/parch/data/configs/158x210-mos-left.toml). MOS strip on the left. This profile ships cover, Contents, the calendar sections, and the colophon (no projects, habits, review, tasks, or meetings). Previews are Typst SVGs at half scale. Regenerate with:
+
+```shell
+uv run parch preview-svg 158x210-mos-left --samples
+```
+
+| Section | Page |
+| --- | --- |
+| Cover | <img src="docs/samples/158x210-mos-left/cover.svg" alt="Cover" width="224" /> |
+| Contents | <img src="docs/samples/158x210-mos-left/contents.svg" alt="Contents" width="224" /> |
+| Annual | <img src="docs/samples/158x210-mos-left/annual.svg" alt="Annual" width="224" /> |
+| Quarterly | <img src="docs/samples/158x210-mos-left/quarterly-q1.svg" alt="Quarterly" width="224" /> |
+| Monthly | <img src="docs/samples/158x210-mos-left/monthly-jan.svg" alt="Monthly" width="224" /> |
+| Weekly | <img src="docs/samples/158x210-mos-left/weekly-w01.svg" alt="Weekly" width="224" /> |
+| Daily | <img src="docs/samples/158x210-mos-left/daily-jan1.svg" alt="Daily" width="224" /> |
+| Daily notes | <img src="docs/samples/158x210-mos-left/notes-jan1.svg" alt="Daily notes" width="224" /> |
+| Colophon | <img src="docs/samples/158x210-mos-left/colophon.svg" alt="Colophon" width="224" /> |
+
+## Device profiles
+
+Sizes are 1:1 on glass at 300 PPI.
+
+| Device | Pixels | Page (pt) | Page (mm) | Config |
+| --- | --- | --- | --- | --- |
+| SuperNote Nomad (A6 X2) | 1404×1872 | 336.96×449.28 | 118.87×158.5 | `supernote-nomad` |
+| SuperNote Nomad MOS-right | 1404×1872 | 336.96×449.28 | 118.87×158.5 | `supernote-nomad-mos-right` |
+| 158×210 MOS-left | — | 447.87×595.28 | 158×210 | `158x210-mos-left` |
+| 158×210 MOS-left lined | — | 447.87×595.28 | 158×210 | `158x210-mos-left-lined` |
+| 158×210 MOS-right | — | 447.87×595.28 | 158×210 | `158x210-mos-right` |
+| Kindle Scribe | 1860×2480 | 446.4×595.2 | 157.48×209.97 | `kindle-scribe` |
+
+Presets also live in `parch.devices`. The Nomad profile scales strokes, type, and gutters down slightly from the original 158×210 MOS-left gist so the MOS layout still fits the smaller page.
+
+**MOS** is Months on the Side — the navigation style that places a vertical month menu on the side of the page (as opposed to a top breadcrumb trail).
+
+Shipped configs keep the **MOS** (Months on the Side) layout: side menu on the physical left except 158×210 MOS-right and SuperNote Nomad MOS-right (physical right), reversed months/quarters, Monday week start, daily schedule 8–20, 5 priorities, 2 extra daily note pages, dotted scratch pad on most shipped configs (the 158×210 MOS-left lined sibling uses `scratch_pad = "lined"` under `[style]` with daily on-page notes still dotted). `pattern` is per notes area (dotted default; `lined` is the other option). MOS-left/MOS-right names are the physical MOS strip side (nav left / nav right), not which hand you write with. MOS-left is the right-handed writing layout (nav opposite the writing hand); MOS-right is the left-handed writing layout.
+
+Device profiles and locale files are TOML. Config keys use underscores (`week_starts`, `side_menu`, `daily_notes`); filenames may still use hyphens (`supernote-nomad.toml`).
+
+## Development
+
+```shell
+cd parch
+uv sync
+```
+
+## Tests
+
+```shell
+uv run pytest
+```
+
+CI runs pytest and a Nomad `parch generate`. Visual design checks live in `tests/visual.py` and can be dropped with the tests that import them.
+
+## Layout of a generated planner
+
+Enabled MOS (Months on the Side) sections, in order:
+
+1. Cover
+2. Annual (12 little calendars)
+3. Quarterly
+4. Monthly
+5. Weekly
+6. Daily (schedule + little calendar + priorities + notes)
+7. Daily notes (extra dotted pages)
+8. Projects (index of write-in names + one kanban board per project)
+9. Habits (index of 12 months + one habit-tracker grid per month)
+10. Review (index of weeks + one lined leftover-notes page per week; no MOS)
+11. Meetings (index of write-in names + one lined page per meeting)
+12. Colophon (quiet About page)
+
+`[section.projects]` takes optional `pages` (default 16) and `card_rows` (default 5). Only Nomad ships projects enabled.
+`[section.habits]` takes optional `habit_columns` (default 6) and `names` (default `[]`; first N header slots are typeset, the rest stay write-in). Enabled on both Nomad profiles.
+`[section.review]` takes optional `weeks_per_page` (default 13). The week field is lined by default and can be `pattern = "dotted"`. Listing `review` without a table uses those defaults. Enabled on both Nomad profiles after Habits.
+`[section.meetings]` takes optional `index_pages` (default 1). Enabled on Nomad after Review.
+
+Internal PDF links use Typst `#padded_link` / `<label>` the same way LYP does. A link is only emitted when the target page exists; otherwise the cell stays plain text.
+
+## License
+
+MIT. This is a port of Vitaliy Kudryk's LYP (MIT 2026). See `LICENSE`.