Metadata-Version: 2.4
Name: parqx
Version: 0.5.0
Summary: TUI Parquet inspector
Author: Senyu Xie
Author-email: Senyu Xie <senyuxie@qq.com>
License-File: LICENSE
License-File: NOTICE
Requires-Dist: duckdb>=1.5.5,<2
Requires-Dist: platformdirs>=4.10.0
Requires-Dist: pyarrow>=24.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: repository, https://github.com/SenyuXie/parqx.git
Description-Content-Type: text/markdown

# Parqx

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

![Parqx app screenshot](https://github.com/user-attachments/assets/2df09bca-9ee6-423d-a4dd-dac0e9297cc6)

## 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`               | Select the current cell       |
| `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) |

### SQL query

| Key                  | Action                       |
| ---                  | ---                          |
| `ctrl+p` → **Query** | Open a blank query workspace |
| `ctrl+enter`         | Run the complete SQL query   |
| `enter`              | Insert a newline             |
| `tab`                | Indent                       |
| `shift+tab`          | Move focus backward          |
| `escape`             | Restore a maximized panel    |

### Sources

| Key                    | Action                         |
| ---                    | ---                            |
| `ctrl+p` → **Sources** | Show or hide files and schemas |
| `←` / `→`              | Collapse or expand a tree item |
| `enter`                | Open the selected file tab     |

## License

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

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