marimo-book 0.1.0__tar.gz

marimo_book-0.1.0/.github/release-drafter.yml

@@ -0,0 +1,64 @@
+# release-drafter config — https://github.com/release-drafter/release-drafter
+#
+# Maintains a single draft Release on github.com/<repo>/releases that gets
+# updated whenever a PR merges to main. The draft accumulates entries
+# categorised by PR label; when you cut a release you tag the commit and
+# the draft auto-publishes against that tag.
+
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+
+categories:
+  - title: "Added"
+    labels:
+      - "enhancement"
+      - "feature"
+  - title: "Changed"
+    labels:
+      - "change"
+      - "refactor"
+      - "performance"
+  - title: "Fixed"
+    labels:
+      - "bug"
+      - "fix"
+  - title: "Removed"
+    labels:
+      - "removal"
+      - "breaking"
+  - title: "Documentation"
+    labels:
+      - "documentation"
+      - "docs"
+  - title: "Build & CI"
+    labels:
+      - "ci"
+      - "build"
+      - "dependencies"
+
+change-template: "- $TITLE (#$NUMBER) @$AUTHOR"
+change-title-escapes: '\<*_&'
+
+# Resolve next version from labels: `breaking` → minor bump (we're 0.x),
+# `feature` → patch, anything else → patch. Tweak when we hit 1.0.
+version-resolver:
+  major:
+    labels: ["major"]
+  minor:
+    labels: ["breaking", "feature", "enhancement"]
+  patch:
+    labels: ["bug", "fix", "documentation", "ci", "build"]
+  default: patch
+
+# Filter out merge commits and dependabot noise from auto-categorisation.
+exclude-labels:
+  - "skip-changelog"
+exclude-contributors:
+  - "dependabot"
+
+template: |
+  ## What's changed
+
+  $CHANGES
+
+  **Full diff:** https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

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

@@ -0,0 +1,94 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Lint
+        run: ruff check src/ tests/
+      - name: Format check
+        run: ruff format --check src/ tests/
+      - name: Test
+        run: pytest -q
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install build backend
+        run: python -m pip install build
+      - name: Build sdist + wheel
+        run: python -m build
+      - name: Verify wheel contents
+        run: |
+          python -c "
+          import zipfile, pathlib
+          wheel = next(pathlib.Path('dist').glob('marimo_book-*.whl'))
+          with zipfile.ZipFile(wheel) as z:
+              names = z.namelist()
+          required = [
+              'marimo_book/cli.py',
+              'marimo_book/preprocessor.py',
+              'marimo_book/assets/marimo_book.js',
+              'marimo_book/assets/scaffold/book.yml',
+              'marimo_book/assets/scaffold/.gitignore',
+              'marimo_book/assets/scaffold/.github/workflows/deploy.yml',
+          ]
+          missing = [f for f in required if f not in names]
+          if missing:
+              raise SystemExit(f'wheel missing files: {missing}')
+          print(f'wheel OK ({len(names)} entries)')
+          "
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ github.sha }}
+          path: dist/
+          retention-days: 7
+
+  docs:
+    # Validates that the self-hosted docs book still builds — catches
+    # regressions before they land on main. The real deploy happens in
+    # docs.yml on push to main.
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install system deps for social-card generation
+        run: sudo apt-get update -y && sudo apt-get install -y libcairo2 libpango-1.0-0 libpangocairo-1.0-0
+      - name: Install marimo-book with linkcheck + social + autorefs + pdf extras
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[linkcheck,social,autorefs,pdf]'
+      - name: Build docs --strict (also exercises social-card generation)
+        run: marimo-book build -b docs/book.yml --strict

marimo_book-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Build and deploy docs
+
+# Self-host marimo-book's own docs (built with marimo-book) on GitHub
+# Pages. Triggered on pushes to main that touch the docs tree or the
+# package source (so tool changes also re-render the docs immediately).
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "src/**"
+      - "pyproject.toml"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs-pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install system deps for social-card generation
+        run: sudo apt-get update -y && sudo apt-get install -y libcairo2 libpango-1.0-0 libpangocairo-1.0-0
+      - name: Install marimo-book + extras for docs build
+        run: pip install -e '.[linkcheck,social,autorefs,pdf]'
+      - name: Build docs
+        run: marimo-book build -b docs/book.yml --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_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

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

@@ -0,0 +1,53 @@
+name: Publish to PyPI
+
+# Publishes on any tag matching v*.
+# Uses PyPI's Trusted Publisher setup (OIDC — no API token needed) — you
+# must first register this repo + workflow on PyPI:
+# https://docs.pypi.org/trusted-publishers/
+#
+# Project name on PyPI: marimo-book
+# Owner / repo:        ljchang/marimo-book
+# Workflow name:       publish.yml
+# Environment name:    pypi-publish
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write  # required for PyPI Trusted Publisher
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Build sdist + wheel
+        run: |
+          python -m pip install build
+          python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi-publish
+      url: https://pypi.org/p/marimo-book
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        # No `with:` block needed — trusted publishing pulls creds from
+        # PyPI's OIDC handshake with GitHub.

marimo_book-0.1.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,22 @@
+name: Release Drafter
+
+# Updates the draft GitHub Release whenever a PR merges to main. The
+# draft accumulates entries grouped by PR label; the draft is published
+# (auto-tagging the commit) when you click "Publish release" on github.com.
+# The published `v*` tag then triggers publish.yml → PyPI.
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write   # required to draft releases
+  pull-requests: read
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

marimo_book-0.1.0/.gitignore

@@ -0,0 +1,59 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+.env
+
+# Testing / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+
+# Type checkers
+.mypy_cache/
+.pyre/
+.pytype/
+.ruff_cache/
+
+# marimo-book build artifacts
+_site/
+_site_src/
+.marimo_book_cache/
+
+# Editors
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+
+# uv
+uv.lock
+.python-version
+__marimo__/
+
+# hatch-vcs build hook output — version materialised at build time
+src/marimo_book/_version.py
+
+# Browser-automation artifacts (Playwright MCP screenshots, snapshots)
+.playwright-mcp/
+# Stray screenshots at repo root only — leading slash anchors to root,
+# so legit assets under .github/, docs/, src/, etc. are unaffected.
+/*.png
+/*.jpg
+/*.jpeg