Metadata-Version: 2.4
Name: parqx
Version: 0.6.1
Summary: TUI Parquet inspector
Author: Senyu Xie
Author-email: Senyu Xie <senyuxie@qq.com>
License-File: LICENSE
License-File: NOTICE
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: duckdb>=1.5.5,<2
Requires-Dist: platformdirs>=4.10.0
Requires-Dist: pyarrow>=24.0.0
Requires-Dist: rich>=15.0.0
Requires-Dist: textual[syntax]>=8.2.7
Requires-Dist: typer>=0.26.7
Requires-Dist: tzdata>=2026.2 ; sys_platform == 'win32'
Requires-Python: >=3.12
Project-URL: homepage, https://github.com/SenyuXie/parqx
Project-URL: repository, https://github.com/SenyuXie/parqx
Description-Content-Type: text/markdown

# Parqx

[![PyPI version](https://img.shields.io/pypi/v/parqx)](https://pypi.org/project/parqx/)
[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://pypi.org/project/parqx/#requires)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Parqx is a lightweight terminal UI for inspecting Apache Parquet files.

![Parqx screenshot](https://github.com/user-attachments/assets/ff7d1f08-1f64-4f9d-a22f-c171f8bbf20a)

## Installation

Parqx requires Python 3.12 or newer.

```bash
pip install parqx
```

## Usage

Open a Parquet file:

```bash
parqx data/weather.parquet
```

Open several files at once:

```bash
parqx users.parquet orders.parquet
parqx data/*.parquet
```

## Keyboard control

### Navigation

| Key                   | Action                          |
| ---                   | ---                             |
| `↑` / `↓`             | Move the cursor up or down      |
| `←` / `→`             | Move the cursor left or right   |
| `pageUp` / `pageDown` | Move one page up or down        |
| `home`                | Move to the leftmost column     |
| `end`                 | Move to the rightmost column    |
| `ctrl+home`           | Move to the first row           |
| `ctrl+end`            | Move to the last row            |
| `enter`               | Inspect the current cell or row |
| `ctrl+w`              | Close the current tab           |

### Table View

These display shortcuts apply while a table has focus.

| Key | Action                                         |
| --- | ---                                            |
| `h` | Toggle the column header row                   |
| `i` | Toggle the row-index column                    |
| `z` | Toggle zebra striping                          |
| `c` | Cycle cursor type (cell → row → column → none) |
| `v` | Show or hide the selected value sidebar        |

### Value browser

Press `tab` from the table to focus the open sidebar.

| Key                   | Action                               |
| ---                   | ---                                  |
| `↑` / `↓`             | Select the previous or next item     |
| `home` / `end`        | Select the first or last item        |
| `pageUp` / `pageDown` | Move one page up or down             |
| `enter`               | Open the selected item               |
| `backspace`           | Return to the parent (table at root) |
| `esc`                 | Return focus to the table            |

## License

Parqx is licensed under the MIT License. See [LICENSE](LICENSE) for details.

This project includes code derived from Textual; see [NOTICE](NOTICE).
