Skip to main content

iparq

Python package

Dependabot Updates

Upload Python Package

codecov

alt text After reading this blog, I began to wonder which Parquet version and compression methods the everyday tools we rely on actually use, only to find that there's no straightforward way to determine this. That curiosity and the difficulty of quickly discovering such details motivated me to create iparq (Information Parquet). My goal with iparq is to help users easily identify the specifics of the Parquet files generated by different engines, making it clear which features—like newer encodings or certain compression algorithms—the creator of the parquet is using.

Features

  • Bloom filters: Detects real Bloom-filter metadata and reports its size. Read more in this great article.
  • Encodings and types: Shows physical and logical types plus encodings such as RLE_DICTIONARY, DELTA_BINARY_PACKED, and BYTE_STREAM_SPLIT.
  • Indexes and dictionary pages: Reports dictionary pages, column indexes, and offset indexes.
  • Statistics: Displays min/max values and available null and distinct counts.
  • Row groups and sort order: Shows row-group sizes, row counts, and declared sorting columns.
  • Page locations: Reports column-chunk, dictionary-page, data-page, and Bloom-filter offsets.
  • Schema details: Includes legacy converted types, decimal precision/scale, nesting levels, and GeoParquet statistics availability.
  • Compression: Shows codecs with optional column sizes and compression ratios.
  • Machine-readable output: Emits JSON for scripts and agent workflows.

iParq requires Python 3.10 or later.

Installation

Zero installation - Recommended

  1. Make sure to have Astral's UV installed by following the steps here:

    https://docs.astral.sh/uv/getting-started/installation/

  2. Execute the following command:

    uvx --refresh iparq inspect yourparquet.parquet
    

Using pip

  1. Install the package using pip:

    pip install iparq
    
  2. Verify the installation by running:

    iparq --help
    

Using uv

  1. Make sure to have Astral's UV installed by following the steps here:

    https://docs.astral.sh/uv/getting-started/installation/

  2. Execute the following command:

    uv pip install iparq
    
  3. Verify the installation by running:

    iparq --help
    

Using Homebrew in a MAC

  1. Run the following:

    brew tap MiguelElGallo/tap https://github.com/MiguelElGallo//homebrew-iparq.git
    brew install MiguelElGallo/tap/iparq
    iparq --help
    

Usage

iparq supports inspecting single files, multiple files, and glob patterns:

iparq inspect <filename(s)> [OPTIONS]

Options include:

  • --format, -f: Output format, either rich (default) or json
  • --metadata-only, -m: Show only file metadata without column details
  • --column, -c: Filter results to show only a specific column
  • --sizes, -s: Show column sizes and compression ratios
  • --details, -d: Show row groups, sort order, encodings, types, indexes, page locations, Bloom-filter size, and detailed statistics

Single File Examples:

# Basic inspection .
iparq inspect yourfile.parquet

# Output in JSON format
iparq inspect yourfile.parquet --format json

# Show only metadata
iparq inspect yourfile.parquet --metadata-only

# Filter to show only a specific column
iparq inspect yourfile.parquet --column column_name

# Show column sizes and compression ratios
iparq inspect yourfile.parquet --sizes

# Show storage-level details
iparq inspect yourfile.parquet --details

Multiple Files and Glob Patterns:

# Inspect multiple specific files
iparq inspect file1.parquet file2.parquet file3.parquet

# Use glob patterns to inspect all parquet files
iparq inspect *.parquet

# Use specific patterns
iparq inspect yellow*.parquet data_*.parquet

# Combine patterns and specific files
iparq inspect important.parquet temp_*.parquet

When inspecting multiple files, each file's results are displayed with a header showing the filename. The utility will read the metadata of each file and print the compression codecs used in the parquet files.

For scripts and agents, add --format json. A single file produces one JSON object; multiple files produce one JSON array whose entries include file. Diagnostics are written to stderr, and any unreadable input makes the command exit non-zero without corrupting successful JSON output.

Agent discovery

iParq publishes CLI and Agent Skill documentation, an Agentic Resource Discovery (ARD) catalog, an agent-readable documentation index, and a portable Parquet inspection skill. The catalog advertises the existing read-only CLI and its JSON output; it does not add a network service or change how iParq accesses files.

Projects that declare iParq as a dependency can install the version-matched skill bundled in the Python package:

uv add iparq
uvx library-skills install --skill iparq-parquet-inspector --yes

This creates a project-local .agents/skills/iparq-parquet-inspector symlink to the skill in the installed iParq package. It is separate from ephemeral CLI execution with uvx iparq, which does not add iParq to the project environment.

Example output

ParquetMetaModel(
    created_by='parquet-cpp-arrow version 14.0.2',
    num_columns=3,
    num_rows=3,
    num_row_groups=1,
    format_version='2.6',
    serialized_size=2223,
    key_value_metadata_keys=['ARROW:schema', 'pandas']
)
                                     Parquet Column Information                                      
┏━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓
┃ Row Group ┃ Column Name ┃ Index ┃ Compression ┃ Bloom ┃ Min Value ┃ Max Value ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩
│     0     │ one         │   0   │ SNAPPY      │  ❌   │ -1.0      │ 2.5       │
│     0     │ two         │   1   │ SNAPPY      │  ❌   │ bar       │ foo       │
│     0     │ three       │   2   │ SNAPPY      │  ❌   │ False     │ True      │
└───────────┴─────────────┴───────┴─────────────┴───────┴───────────┴───────────┘
Compression codecs: {'SNAPPY'}

With --sizes flag

iparq inspect yourfile.parquet --sizes

                                         Parquet Column Information                                         
┏━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━┓
┃  Row   ┃ Column  ┃       ┃        ┃       ┃           ┃           ┃        ┃        ┃       ┃
┃ Group  ┃ Name    ┃ Index ┃ Compr… ┃ Bloom ┃ Min Value ┃ Max Value ┃ Values ┃ Compr… ┃ Ratio ┃
┡━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━┩
│   0    │ one     │   0   │ SNAPPY │  ❌   │ -1.0      │ 2.5       │      3 │ 104.0B │  1.0x │
│   0    │ two     │   1   │ SNAPPY │  ❌   │ bar       │ foo       │      3 │  80.0B │  0.9x │
│   0    │ three   │   2   │ SNAPPY │  ❌   │ False     │ True      │      3 │  42.0B │  1.0x │
└────────┴─────────┴───────┴────────┴───────┴───────────┴───────────┴────────┴────────┴───────┘

Download files

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

Source Distribution

iparq-0.7.2.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

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

iparq-0.7.2-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file iparq-0.7.2.tar.gz.

File metadata

  • Download URL: iparq-0.7.2.tar.gz
  • Upload date:
  • Size: 4.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for iparq-0.7.2.tar.gz
Algorithm Hash digest
SHA256 058b9b53a9fed06e0478a92a358838dd2b71b9c532389200be4916581a494e45
MD5 fb3a0999609554f1c3a6f4dd6dea8eb7
BLAKE2b-256 eceb805aeec526e8df55825cfdf83ce3b6d6a91975a28a9649f9b2de29beb137

See more details on using hashes here.

Provenance

The following attestation bundles were made for iparq-0.7.2.tar.gz:

Publisher: python-publish.yml on MiguelElGallo/iparq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iparq-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: iparq-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for iparq-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a31ef8315dcaf350f97966ff75c17356be492898febca416cefeaca3f0c3d1e5
MD5 a777efec94156ab3a6c6f85134a7610a
BLAKE2b-256 7a94e4be0d1f2721e39a29efc7231e4d98bb48de7128e9b4e97980b5d5365a0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for iparq-0.7.2-py3-none-any.whl:

Publisher: python-publish.yml on MiguelElGallo/iparq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.8.1

2 files

0.8.0

2 files

0.7.3

2 files

This release

0.7.2 This release

2 files

0.7.1

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.6

2 files

0.2.5

2 files

0.2.0

2 files

0.1.7

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page