coeftable 0.1.0__tar.gz

coeftable-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+## Summary
+
+<!-- What does this PR change, and why? -->

coeftable-0.1.0/.github/release.yml

@@ -0,0 +1,10 @@
+changelog:
+  categories:
+    - title: New Features
+      labels: [feature, enhancement]
+    - title: Bug Fixes
+      labels: [fix, bug]
+    - title: Documentation
+      labels: [documentation]
+    - title: Maintenance
+      labels: ["*"]

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

@@ -0,0 +1,33 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v6
+      - run: make setup
+      - name: prek check
+        uses: j178/prek-action@v1
+        env:
+          SKIP: no-commit-to-branch
+
+  test:
+    runs-on: ubuntu-latest
+    needs: prek
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv run --with nox nox -s "tests-${{ matrix.python-version }}"

coeftable-0.1.0/.github/workflows/post-release.yml

@@ -0,0 +1,24 @@
+name: Post-release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  changelog:
+    name: Update changelog
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: main
+      - uses: rhysd/changelog-from-release/action@v3
+        with:
+          file: CHANGELOG.md
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          commit_summary_template: "update changelog for %s changes"
+          pull_request: true

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

@@ -0,0 +1,38 @@
+name: Publish library
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - "v*"
+
+jobs:
+  build-package:
+    runs-on: ubuntu-latest
+    permissions:
+      attestations: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: hynek/build-and-inspect-python-package@v2
+        with:
+          attest-build-provenance-github: true
+
+  publish:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    environment:
+      name: publish
+      url: https://pypi.org/p/coeftable
+    needs: build-package
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: Packages
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

coeftable-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.py[cod]
+.venv/
+.nox/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+.ipynb_checkpoints/
+.DS_Store
+src/coeftable/_version.py
+.kata.toml
+.kata.local.toml
+# roborev snapshots
+/.roborev/

coeftable-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+ci:
+  autofix_prs: false
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.6
+    hooks:
+      - id: ruff-check
+        types_or: [python, pyi, jupyter]
+        args: ["--fix", "--output-format=full"]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.49
+    hooks:
+      - id: ty
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: no-commit-to-branch
+        args: [--branch, main]
+        stages: [pre-commit, pre-merge-commit, pre-push, manual]
+      - id: debug-statements
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-toml
+      - id: check-yaml
+      - id: check-added-large-files

coeftable-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kyle Caron
+
+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.

coeftable-0.1.0/Makefile

@@ -0,0 +1,20 @@
+.PHONY: setup tests tests-all lint typecheck prek
+
+setup:
+	uv sync --all-extras
+	uv run prek install
+
+tests:
+	uv run pytest
+
+tests-all:
+	uv run nox -s tests
+
+lint:
+	uv run nox -s lint
+
+typecheck:
+	uv run nox -s typecheck
+
+prek:
+	SKIP=no-commit-to-branch uv run prek run --all-files

coeftable-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: coeftable
+Version: 0.1.0
+Summary: Publication-quality summary tables for estimates with uncertainty.
+Project-URL: Homepage, https://github.com/kylejcaron/coeftable
+Project-URL: Repository, https://github.com/kylejcaron/coeftable
+Project-URL: Issues, https://github.com/kylejcaron/coeftable/issues
+Author-email: Kyle Caron <kyle.j.caron@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Kyle Caron
+        
+        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: confidence-interval,forest-plot,great-tables,statistics,tables
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Requires-Dist: great-tables>=0.22
+Requires-Dist: narwhals>=2.24
+Provides-Extra: dev
+Requires-Dist: nox>=2025.5; extra == 'dev'
+Requires-Dist: pandas>=2.2; extra == 'dev'
+Requires-Dist: polars>=1.0; extra == 'dev'
+Requires-Dist: prek>=0.4.5; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.15; extra == 'dev'
+Requires-Dist: ty>=0.0.49; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# coeftable
+
+Lightweight, report-ready summary tables for estimates with uncertainty. Renders
+inline forest plots, builds on great_tables HTML output, and works with pandas,
+polars, or pyarrow frames.
+
+![Rendered experiment results table with grouped sections, nested variants, and an inline forest plot](docs/images/example.png)
+
+## Installation
+
+```bash
+uv add coeftable
+```
+
+## Quick start
+
+The one-line form declares a table with a single estimate column:
+
+```python
+import polars as pl
+import coeftable as ct
+
+df = pl.DataFrame(
+    {
+        "metric": ["Revenue", "Latency"],
+        "est": [3.4, 0.5],
+        "lb": [1.2, -1.0],
+        "ub": [5.7, 2.0],
+    }
+)
+
+ct.CoefTable(df, rows="metric", estimate="est", ci=("lb", "ub"))
+```
+
+A `CoefTable` renders itself in marimo, Jupyter, and any other `_repr_html_`-aware viewer —
+leave it as the last expression in a cell, no extra call needed. Outside a notebook, use
+`.gt()` to reach the underlying [great_tables](https://posit-dev.github.io/great-tables/)
+object: `table.gt().as_raw_html()` for an HTML string, `table.gt().save("t.png")` for an
+image, `table.gt().tab_options(...)` to keep styling with great_tables' own API.
+
+## Experiment table
+
+Build a complete experiment results table with multiple estimates, a forest
+plot column, grouped row sections, nested variants, and direction hints:
+
+```python
+import polars as pl
+import coeftable as ct
+
+experiment = pl.DataFrame(
+    {
+        "area": ["Core", "Core", "Ops", "Ops"],
+        "metric": ["Revenue", "Revenue", "Latency", "Latency"],
+        "variant": ["B", "C", "B", "C"],
+        "att": [12400.0, -3100.0, 40.0, 120.0],
+        "att_lb": [4200.0, -9800.0, -80.0, 45.0],
+        "att_ub": [20600.0, 3600.0, 160.0, 195.0],
+        "rel": [3.4, -1.2, 0.5, 2.0],
+        "rel_lb": [1.2, -4.0, -1.0, 0.8],
+        "rel_ub": [5.7, 1.6, 2.0, 3.2],
+    }
+)
+
+(
+    ct.CoefTable(experiment, rows="metric", nest="variant", groups="area")
+    .estimate("Lift Amount", "att", ci=("att_lb", "att_ub"), fmt=ct.Number(compact=True))
+    .estimate("Lift %", "rel", ci=("rel_lb", "rel_ub"), fmt=ct.Percent(signed=True))
+    .forest("Lift Plot", of="Lift %", ref=0.0, symmetric=True)
+    .header("Experiment Results", "Example Experiment")
+    .with_direction({"Latency": "lower_is_better"})
+)
+```
+
+## Comparing methods
+
+Use `split_columns` to compare multiple methods side by side. Each value in the
+split column produces its own set of estimate / forest columns:
+
+```python
+import polars as pl
+import coeftable as ct
+
+methods = pl.DataFrame(
+    {
+        "metric": ["Revenue", "Revenue", "Latency", "Latency"],
+        "method": ["A", "B", "A", "B"],
+        "est": [3.4, 3.1, 0.5, 0.6],
+        "lb": [1.2, 1.0, -1.0, -0.8],
+        "ub": [5.7, 5.2, 2.0, 2.1],
+    }
+)
+
+(
+    ct.CoefTable(
+        methods, rows="metric", split_columns="method", estimate="est", ci=("lb", "ub")
+    )
+    .header("Cohort Revenue by Method")
+)
+```
+
+## Theming
+
+Four built-in themes are available from `coeftable.theme`:
+
+```python
+from coeftable.theme import BLUE, COLORBLIND, DEFAULT, MONO, TEXTUAL
+
+DEFAULT       # Alias for TEXTUAL -- what CoefTable uses if you don't set a theme
+TEXTUAL       # Minimal, publication-style: muted colours, light chrome
+BLUE          # The original blue-grey palette
+COLORBLIND    # Colourblind-safe palette
+MONO          # Grayscale for mono journals
+```
+
+Apply one with `.with_theme(...)`:
+
+```python
+table.with_theme(BLUE)
+```
+
+Customise a theme with `dataclasses.replace`:
+
+```python
+from dataclasses import replace
+
+my_theme = replace(BLUE, favorable="#0072B2")
+```
+
+Use `with_direction` to mark rows where lower values are favourable (reusing
+the `df` frame from [Quick start](#quick-start)):
+
+```python
+table = (
+    ct.CoefTable(df, rows="metric", estimate="est", ci=("lb", "ub"))
+    .with_direction({"Latency": "lower_is_better"})
+)
+```
+
+## Data shape
+
+coeftable expects a dataframe where every row is a single comparison. The
+resolution logic maps pairs of upper / lower bound columns to each estimate, so
+your data should be **wide in triples** — one point-estimate column and (when
+applicable) its lower and upper bound columns — rather than in long format with
+a `parameter` column.
+
+**Dimensions:**
+- `rows` — the label for each row in the table (e.g. a metric name).
+- `nest` — an optional secondary label stacked below each row.
+- `groups` — an optional column whose values produce section headers.
+- `split_columns` — an optional column whose values produce repeated column
+  groups side by side, useful for comparing methods.

coeftable-0.1.0/README.md

@@ -0,0 +1,152 @@
+# coeftable
+
+Lightweight, report-ready summary tables for estimates with uncertainty. Renders
+inline forest plots, builds on great_tables HTML output, and works with pandas,
+polars, or pyarrow frames.
+
+![Rendered experiment results table with grouped sections, nested variants, and an inline forest plot](docs/images/example.png)
+
+## Installation
+
+```bash
+uv add coeftable
+```
+
+## Quick start
+
+The one-line form declares a table with a single estimate column:
+
+```python
+import polars as pl
+import coeftable as ct
+
+df = pl.DataFrame(
+    {
+        "metric": ["Revenue", "Latency"],
+        "est": [3.4, 0.5],
+        "lb": [1.2, -1.0],
+        "ub": [5.7, 2.0],
+    }
+)
+
+ct.CoefTable(df, rows="metric", estimate="est", ci=("lb", "ub"))
+```
+
+A `CoefTable` renders itself in marimo, Jupyter, and any other `_repr_html_`-aware viewer —
+leave it as the last expression in a cell, no extra call needed. Outside a notebook, use
+`.gt()` to reach the underlying [great_tables](https://posit-dev.github.io/great-tables/)
+object: `table.gt().as_raw_html()` for an HTML string, `table.gt().save("t.png")` for an
+image, `table.gt().tab_options(...)` to keep styling with great_tables' own API.
+
+## Experiment table
+
+Build a complete experiment results table with multiple estimates, a forest
+plot column, grouped row sections, nested variants, and direction hints:
+
+```python
+import polars as pl
+import coeftable as ct
+
+experiment = pl.DataFrame(
+    {
+        "area": ["Core", "Core", "Ops", "Ops"],
+        "metric": ["Revenue", "Revenue", "Latency", "Latency"],
+        "variant": ["B", "C", "B", "C"],
+        "att": [12400.0, -3100.0, 40.0, 120.0],
+        "att_lb": [4200.0, -9800.0, -80.0, 45.0],
+        "att_ub": [20600.0, 3600.0, 160.0, 195.0],
+        "rel": [3.4, -1.2, 0.5, 2.0],
+        "rel_lb": [1.2, -4.0, -1.0, 0.8],
+        "rel_ub": [5.7, 1.6, 2.0, 3.2],
+    }
+)
+
+(
+    ct.CoefTable(experiment, rows="metric", nest="variant", groups="area")
+    .estimate("Lift Amount", "att", ci=("att_lb", "att_ub"), fmt=ct.Number(compact=True))
+    .estimate("Lift %", "rel", ci=("rel_lb", "rel_ub"), fmt=ct.Percent(signed=True))
+    .forest("Lift Plot", of="Lift %", ref=0.0, symmetric=True)
+    .header("Experiment Results", "Example Experiment")
+    .with_direction({"Latency": "lower_is_better"})
+)
+```
+
+## Comparing methods
+
+Use `split_columns` to compare multiple methods side by side. Each value in the
+split column produces its own set of estimate / forest columns:
+
+```python
+import polars as pl
+import coeftable as ct
+
+methods = pl.DataFrame(
+    {
+        "metric": ["Revenue", "Revenue", "Latency", "Latency"],
+        "method": ["A", "B", "A", "B"],
+        "est": [3.4, 3.1, 0.5, 0.6],
+        "lb": [1.2, 1.0, -1.0, -0.8],
+        "ub": [5.7, 5.2, 2.0, 2.1],
+    }
+)
+
+(
+    ct.CoefTable(
+        methods, rows="metric", split_columns="method", estimate="est", ci=("lb", "ub")
+    )
+    .header("Cohort Revenue by Method")
+)
+```
+
+## Theming
+
+Four built-in themes are available from `coeftable.theme`:
+
+```python
+from coeftable.theme import BLUE, COLORBLIND, DEFAULT, MONO, TEXTUAL
+
+DEFAULT       # Alias for TEXTUAL -- what CoefTable uses if you don't set a theme
+TEXTUAL       # Minimal, publication-style: muted colours, light chrome
+BLUE          # The original blue-grey palette
+COLORBLIND    # Colourblind-safe palette
+MONO          # Grayscale for mono journals
+```
+
+Apply one with `.with_theme(...)`:
+
+```python
+table.with_theme(BLUE)
+```
+
+Customise a theme with `dataclasses.replace`:
+
+```python
+from dataclasses import replace
+
+my_theme = replace(BLUE, favorable="#0072B2")
+```
+
+Use `with_direction` to mark rows where lower values are favourable (reusing
+the `df` frame from [Quick start](#quick-start)):
+
+```python
+table = (
+    ct.CoefTable(df, rows="metric", estimate="est", ci=("lb", "ub"))
+    .with_direction({"Latency": "lower_is_better"})
+)
+```
+
+## Data shape
+
+coeftable expects a dataframe where every row is a single comparison. The
+resolution logic maps pairs of upper / lower bound columns to each estimate, so
+your data should be **wide in triples** — one point-estimate column and (when
+applicable) its lower and upper bound columns — rather than in long format with
+a `parameter` column.
+
+**Dimensions:**
+- `rows` — the label for each row in the table (e.g. a metric name).
+- `nest` — an optional secondary label stacked below each row.
+- `groups` — an optional column whose values produce section headers.
+- `split_columns` — an optional column whose values produce repeated column
+  groups side by side, useful for comparing methods.

coeftable-0.1.0/noxfile.py

@@ -0,0 +1,30 @@
+"""Test, lint, and typecheck sessions."""
+
+import nox
+
+nox.options.default_venv_backend = "uv"
+nox.options.reuse_existing_virtualenvs = True
+
+PYTHON_VERSIONS = ["3.12", "3.13", "3.14"]
+
+
+@nox.session(python=PYTHON_VERSIONS)
+def tests(session):
+    """Run the test suite against every supported Python version."""
+    session.install("-e", ".[dev]")
+    session.run("pytest")
+
+
+@nox.session(python="3.12")
+def lint(session):
+    """Check formatting and lint rules."""
+    session.install("ruff>=0.15")
+    session.run("ruff", "check", "src", "tests")
+    session.run("ruff", "format", "--check", "src", "tests")
+
+
+@nox.session(python="3.12")
+def typecheck(session):
+    """Run the static type checker."""
+    session.install("-e", ".[dev]")
+    session.run("ty", "check", "src", "tests")