pq-peek 0.1.1__tar.gz → 0.1.2__tar.gz

pq_peek-0.1.2/PKG-INFO

@@ -0,0 +1,68 @@
+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.

pq_peek-0.1.2/README.md

@@ -0,0 +1,56 @@
+# [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.

{pq_peek-0.1.1 → pq_peek-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pq-peek"
-version = "0.1.1"
+version = "0.1.2"
 description = "A blazing fast CLI tool to inspect Parquet files using Polars."
 readme = "README.md"
 authors = [

{pq_peek-0.1.1 → pq_peek-0.1.2}/src/pq_peek/main.py

@@ -9,13 +9,15 @@ from rich.table import Table
 app = typer.Typer(help="A fast CLI tool to inspect Parquet files")
 console = Console()
 
+
 def get_scan(file_path: Path) -> pl.LazyFrame:
     verify_path(file_path)
     return pl.scan_parquet(file_path)
 
+
 def verify_path(file_path: Path):
     """
-    Verifies that the file exists and checks the correct ending 
+    Verifies that the file exists and checks the correct ending
     """
     if not file_path.exists():
         rprint(f"[bold red]Error:[/bold red] File was not found: '{file_path}'")
@@ -23,6 +25,7 @@ def verify_path(file_path: Path):
     if file_path.suffix != ".parquet":
         rprint("[bold yellow]Warning:[/bold yellow] File does not end with '.parquet'")
 
+
 @app.command()
 def schema(file_path: Path):
     """
@@ -43,9 +46,12 @@ def schema(file_path: Path):
         console.print(table)
         rprint(f"\n[green]Amount of columns:[/green] {len(schema)}")
     except Exception as failure:
-        rprint(f"[bold red]Failure while reading the parquet file:[/bold red] {failure}")
+        rprint(
+            f"[bold red]Failure while reading the parquet file:[/bold red] {failure}"
+        )
         raise typer.Exit(code=1)
 
+
 @app.command()
 def head(file_path: Path, n: int = typer.Option(5, help="Amount of rows")):
     """
@@ -58,7 +64,7 @@ def head(file_path: Path, n: int = typer.Option(5, help="Amount of rows")):
         if df.is_empty():
             rprint("[yellow]File is empty.[/yellow]")
             return
-        
+
         table = Table(title=f"Preview {file_path.name} ({n} rows)")
 
         for column in df.columns:
@@ -67,14 +73,15 @@ def head(file_path: Path, n: int = typer.Option(5, help="Amount of rows")):
         for row in df.iter_rows():
             str_row = [str(x) for x in row]
             table.add_row(*str_row)
-        
+
         console.print(table)
     except Exception as failure:
-        rprint(f"[bold red]Failure while reading the parquet file:[/bold red] {failure}")
+        rprint(
+            f"[bold red]Failure while reading the parquet file:[/bold red] {failure}"
+        )
         raise typer.Exit(code=1)
 
 
-
 @app.command()
 def stats(file_path: Path):
     """
@@ -95,4 +102,4 @@ def stats(file_path: Path):
 
 
 if __name__ == "__main__":
-    app()
+    app()

pq_peek-0.1.1/PKG-INFO

@@ -1,47 +0,0 @@
-Metadata-Version: 2.3
-Name: pq-peek
-Version: 0.1.1
-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 🦆
-
-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 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
-```
-
-## 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.

pq_peek-0.1.1/README.md

@@ -1,35 +0,0 @@
-pq-peek 🦆
-
-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 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
-```
-
-## 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.