Metadata-Version: 2.4
Name: datui
Version: 0.2.51
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering
Requires-Dist: polars>=0.20
Requires-Dist: pytest>=7.0 ; extra == 'dev'
Provides-Extra: dev
License-File: LICENSE
Summary: Data Exploration in the Terminal
Keywords: datui,data,polars,tui,dataframe,eda,tables
Author: Derek Wisong
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/derekwisong/datui/releases
Project-URL: Documentation, https://derekwisong.github.io/datui/
Project-URL: Repository, https://github.com/derekwisong/datui

# Datui

Explore Polars DataFrames in the terminal.

To learn more, see the [full documentation](https://derekwisong.github.io/datui/).

## Installation

Install Datui with `pip`:

```
pip install datui
```

## Usage

**View a LazyFrame or DataFrame**

```python
import polars as pl
import datui

# From a LazyFrame (e.g. scan)
lf = pl.scan_csv("data.csv")
datui.view(lf)
```

Press `q` to exit Datui and return to Python.

## Run at the Command Line

Run the `datui` command line application:

```bash
datui /path/to/data.parquet
```

For help:

```bash
datui --help
```

