tytable 0.6.0__tar.gz

tytable-0.6.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+      - run: uv sync --all-extras
+      - run: uv run ruff check src tests
+      - run: uv run ruff format --check src tests
+      - run: uv run mypy
+
+  test:
+    runs-on: ${{ matrix.os }}
+    env:
+      MPLBACKEND: Agg
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        include:
+          - os: macos-latest
+            python-version: "3.11"
+          - os: windows-latest
+            python-version: "3.11"
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v8.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - run: uv sync --all-extras --python ${{ matrix.python-version }}
+      - run: uv run pytest

tytable-0.6.0/.github/workflows/docs-pages.yml

@@ -0,0 +1,64 @@
+name: Docs site
+
+# Builds the Typst documentation PDF on every push to main and deploys it to
+# GitHub Pages, so the docs are always current without cutting a release.
+# The versioned, per-release PDF is still attached to each GitHub Release by
+# docs-release.yml.
+on:
+  push:
+    branches: [main]
+    paths:
+      - docs/**
+      - src/tytable/**
+      - pyproject.toml
+      - uv.lock
+      - .github/workflows/docs-pages.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Only one in-flight Pages deploy at a time; newer runs cancel older ones.
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install Typst
+        uses: typst-community/setup-typst@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+
+      - name: Sync dependencies
+        run: uv sync --all-extras
+
+      - name: Build documentation
+        run: make docs
+
+      - name: Assemble Pages site
+        run: |
+          mkdir -p _site
+          cp docs/tytable-docs.pdf _site/tytable-docs.pdf
+          cp docs/site/index.html _site/index.html
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v5
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

tytable-0.6.0/.github/workflows/docs-release.yml

@@ -0,0 +1,34 @@
+name: Docs
+
+# Builds the Typst documentation PDF and attaches it to the GitHub Release.
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-pdf:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install Typst
+        uses: typst-community/setup-typst@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+
+      - name: Sync dependencies
+        run: uv sync --all-extras
+
+      - name: Build documentation
+        run: make docs
+
+      - name: Upload PDF to the release
+        if: github.event_name == 'release'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: docs/tytable-docs.pdf

tytable-0.6.0/.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Release
+
+# Cut a release by pushing a `v*` tag, e.g.:
+#   git tag -a v0.6.0 -m "Release v0.6.0"
+#   git push origin v0.6.0
+#
+# The job builds the wheel + sdist with `uv build`, attaches them to a
+# GitHub Release with auto-generated notes, and publishes to PyPI via
+# trusted publishing (no stored API token). Trusted publishing requires
+# this workflow file to exist on the default branch *before* the first
+# tagged run can publish — merge to main before cutting v0.6.0.
+#
+# One-time setup: on PyPI (and TestPyPI for dry runs) add a trusted
+# publisher for EinMaulwurf/tytable, workflow filename `release.yml`,
+# environment `release`.
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write # create the GitHub Release and its notes
+  id-token: write # trusted publishing to PyPI
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: release # matches the trusted-publisher env on PyPI
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # hatch-vcs needs full history to derive version
+
+      - uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Validate metadata
+        run: uvx twine check dist/*
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          prerelease: false
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

tytable-0.6.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.pyc
+.venv/
+.eggs/
+*.egg-info/
+src/tytable/_version.py
+build/
+dist/
+.pytest_cache/
+/pytest-of-*/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+tytable_assets/
+report_assets/
+docs/tytable-docs.pdf
+.DS_Store
+TODO.md
+AUDIT_SUGGESTIONS_FINAL.md
+.opencode/

tytable-0.6.0/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: ^tests/snapshots/
+      - id: end-of-file-fixer
+        exclude: ^tests/snapshots/
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        description: Lint with ruff (autofixes staged issues).
+        entry: uv run ruff check --fix
+        language: system
+        types_or: [python, pyi, toml]
+        pass_filenames: false
+      - id: ruff-format
+        name: ruff format
+        description: Format with ruff.
+        entry: uv run ruff format
+        language: system
+        types_or: [python, pyi]
+        pass_filenames: false
+      - id: mypy
+        name: mypy
+        description: Type-check with mypy.
+        entry: uv run mypy
+        language: system
+        types_or: [python, pyi]
+        pass_filenames: false

tytable-0.6.0/.python-version

@@ -0,0 +1 @@
+3.11

tytable-0.6.0/AGENTS.md

@@ -0,0 +1,75 @@
+# AGENTS.md
+
+## Project identity
+
+**Package**: `tytable` — source: `src/tytable/`
+
+A lightweight Python package for creating typst tables from (polars) dataframes. Inspired by the tinytable R package.
+
+## Commands
+
+```bash
+make install      # uv sync --all-extras
+make lint         # ruff check src tests
+make format       # ruff format src tests
+make typecheck    # mypy
+make test         # pytest -m "not images" (excludes images tests)
+make test-images  # pytest -m "images" (requires matplotlib/numpy)
+```
+
+Pre-commit order: `lint` → `typecheck` → `test`.
+
+## Tooling quirks
+
+- **ruff**: line-length 100, double-quotes, selects E/F/I/UP/B/SIM/C4; E501 ignored
+- **mypy**: non-strict, ignores missing imports, only checks `src/tytable` (not tests)
+- **Coverage**: 80% branch minimum
+
+## Testing
+
+- Custom snapshot helper at `tests/helpers.py:assert_snapshot`. Set `SNAPSHOT_UPDATE=1` to regenerate.
+- `conftest.py` monkeypatches `_new_image_id` for deterministic image tests.
+- Performance gate: `test_perf.py` asserts a 120×30 table renders under 0.3 s.
+- Pytest markers: `typst`, `html`, `images`. Default `make test` skips `images` (needs the `images` extra).
+- The `pytest-snapshot` dep is in `pyproject.toml` but **not** the active snapshot mechanism — `tests/helpers.py` handles snapshots.
+
+## Architecture
+
+```text
+tt(df, ...)               # _tytable.py — factory + TinyTable class
+  .style() / .fmt() / ... # record directives (StyleDirective, FormatDirective, …)
+  .render() / .save()     # resolve pipeline → render
+
+build()                   # _resolve.py — resolve directives → BuiltTable
+  → TypstRenderer         # _render_typst.py
+  → HtmlRenderer          # _render_html.py
+  → AsciiRenderer         # _render_ascii.py
+```
+
+Styling, formatting, grouping, and plotting are recorded as **intent** and replayed in a fixed order at render time. Row indices always refer to the final, visible table.
+
+### Key modules
+
+| File               | Role                                                                                              |
+| ------------------ | ------------------------------------------------------------------------------------------------- |
+| `_tytable.py`      | Public API: `TinyTable` class, `tt()` factory                                                     |
+| `_directives.py`   | Dataclasses: `StyleDirective`, `FormatDirective`, `PlotDirective`, `Note`, `RowGroup`, `ColGroup` |
+| `_resolve.py`      | `build()` pipeline and `BuiltTable` output dataclass                                              |
+| `_styling.py`      | Style validation, style-grid construction                                                         |
+| `_format.py`       | Numeric formatting, replace, escape, fn transforms                                                |
+| `_groups.py`       | Row/column group registration and merging                                                         |
+| `_themes.py`       | Theme registry (`default`, `striped`, `grid`, `empty`, `rotate`)                                  |
+| `_render_typst.py` | Typst output (primary output format)                                                              |
+| `_render_html.py`  | HTML preview (Jupyter `_repr_html_`)                                                              |
+| `_render_ascii.py` | ASCII `__repr__`                                                                                  |
+| `_images.py`       | Plot/image embedding (requires `images` extra)                                                    |
+
+## Commit style
+
+Conventional commits: `type(scope): description`. Types: `feat`, `fix`, `docs`, `test`, `ci`, `build`, `refactor`. Scope optional. Keep descriptions imperative and lowercase. Examples from history: `feat: wire up resize theme`, `fix: resolve all 20 mypy type-checking errors`, `docs: add docstrings to all public API`.
+
+- All source modules start with `_` (private). Public API is only what `__init__.py` exports.
+- **0-based row indexing**: `i=0` is first data row; `i="header"` for column-name row; negative ints for column-group header rows.
+- Column selection by **name** (`j="Score"`) preferred over integer position.
+- Method chaining: `.style()`, `.fmt()`, `.group()`, `.theme()` return `self`. `.render()` / `.save()` are terminal.
+- Internal imports use `from tytable._resolve import build`, not relative paths (most files already use this pattern).