Skip to main content

Emit csv-viewer's CsvGrid interactive tables from pandas DataFrames (Jupyter / Quarto / static HTML).

Project description

csv_grid

Python emitter for CsvGrid, the embeddable interactive table of the csv-viewer project: render a pandas DataFrame as a sortable, filterable, type-aware grid in Jupyter, Quarto (.qmd), or any static HTML you generate.

The grid re-infers column types from the data exactly as the viewer app does (numbers right with greater_tables-style formatting, dates ISO and centered, fzf search, equal-risk column widths). NaN / None become blank cells.

Install

uv add csv-grid              # or: pip install csv-grid

or local path install from a clone of this repo:

uv add --editable path/to/csv-viewer/python

The grid's built JS/CSS assets ship inside the package (refreshed by the repo's npm run build).

Use

from csv_grid import show, to_html

show(df)                          # Jupyter / qmd cell: display the grid
show(df, align="llrcr", fmt=[None, None, ",d", "year", ",.2f"])

html = to_html(df, name="results.df", assets="inline")   # fragment string
  • show(df, **options) displays via IPython. Each grid carries the JS + CSS via an idempotent <head> guard (assets="inline", the default), so fragments are self-contained and re-running/clearing a notebook cell can't strip a shared stylesheet. Use assets="https://…/base" to link the assets from a URL instead, or assets=False if they are already on the page.
  • to_html(df, **options) returns a self-contained HTML fragment; fragments compose freely (no need to mark a "first" one).
  • payload(df) returns the {records, columns} dict the grid consumes, if you want to ship data yourself.
  • Options mirror the JS API in snake_case: global_search, column_filters, sortable, status_bar, expand_buttons, align ('llrcr…'), formats/fmt (per-column [,][.N](f|d|%|e|s), 'year', 'eng', None = auto), width_mode ('equal-risk' default, or 'coverage' to maximize the count of fully-shown cells), display_mode ('auto' formatted / 'raw' verbatim), rows (cap the viewport to ~N rows, vertical scroll for the rest) / max_height (raw CSS, e.g. '400px'), render_cap, eager_cells, worker (default False — data is inlined), plus name (status line) and index (include the DataFrame index as leading columns). Dark mode follows the host page (prefers-color-scheme; JupyterLab dark themes included) unless theme="light"/"dark" forces it.

Dates are emitted ISO (yyyy-mm-dd, with hh:mm only when a column has non-midnight times); integral float columns are emitted as integers so the grid's integer/year rules apply.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

csv_grid-3.3.1.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

csv_grid-3.3.1-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file csv_grid-3.3.1.tar.gz.

File metadata

  • Download URL: csv_grid-3.3.1.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for csv_grid-3.3.1.tar.gz
Algorithm Hash digest
SHA256 f7dc8dabe5d32b1d7739dfc2b1534e5dff225d1844b5cd9ba06b30bd69dfbf1f
MD5 beb92215bfcfb6159646ce48ded39e38
BLAKE2b-256 b99f57f606301b08c7b3e13b487a45a28c464bf90ba8826cc7eea56a60c75369

See more details on using hashes here.

File details

Details for the file csv_grid-3.3.1-py3-none-any.whl.

File metadata

  • Download URL: csv_grid-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for csv_grid-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da9a46fd8d6bb626a0fba04060047ddbc27f4a8a5ebb6adb377de2608d532800
MD5 32aafcaa889db3eeb405a3438645ca45
BLAKE2b-256 1c89c150158c8d2c064e856769e539ae75f09b14a07269026b106213909e05aa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page