Metadata-Version: 2.3
Name: pq-peek
Version: 0.1.2
Summary: A blazing fast CLI tool to inspect Parquet files using Polars.
Author: Lars Lewerenz
Author-email: Lars Lewerenz <git.lars.lewerenz@gmail.com>
Requires-Dist: polars>=1.37.1
Requires-Dist: rich>=14.3.1
Requires-Dist: typer>=0.21.1
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# [pq-peek](https://github.com/lars-lewerenz/pq-peek) 🦆

[![PyPI](https://img.shields.io/pypi/v/pq-peek)](https://pypi.org/project/pq-peek/)
[![Publish](https://github.com/lars-lewerenz/pq-peek/actions/workflows/release.yml/badge.svg)](https://github.com/lars-lewerenz/pq-peek/actions/workflows/release.yml)
[![Lint](https://github.com/lars-lewerenz/pq-peek/actions/workflows/lint.yml/badge.svg)](https://github.com/lars-lewerenz/pq-peek/actions/workflows/lint.yml)
[![CLI Smoke](https://github.com/lars-lewerenz/pq-peek/actions/workflows/smoke.yml/badge.svg)](https://github.com/lars-lewerenz/pq-peek/actions/workflows/smoke.yml)

A blazing fast, memory-efficient CLI tool to inspect large Parquet files directly in the terminal.
Built with *Polars*, *Typer*, and *Rich*. Managed via *uv*.

## Install (uv)

```bash
uv pip install --system pq-peek
```

## CLI usage

```bash
pq-peek schema /path/to/file.parquet
pq-peek head /path/to/file.parquet --n 5
pq-peek stats /path/to/file.parquet
```

## Sample output

```text
                         Preview data.parquet (3 rows)
┏━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ id ┃ price              ┃ category ┃ is_available ┃ description              ┃
┡━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 0  │ 16.00485297904456  │ Clothing │ False        │ Product description      │
│    │                    │          │              │ placeholder              │
│ 1  │ 31.286728959372468 │ Books    │ True         │ Product description      │
│    │                    │          │              │ placeholder              │
│ 2  │ 51.69244000425412  │ Books    │ False        │ Product description      │
│    │                    │          │              │ placeholder              │
└────┴────────────────────┴──────────┴──────────────┴──────────────────────────┘
```

## Module usage

```bash
python -m pq_peek schema /path/to/file.parquet
```

## Build and publish (uv)

```bash
uv build
uv publish
```

## Publishing notes

CI publishing uses GitHub's Trusted Publisher OIDC. See `PUBLISHING.md` for the full release steps.