Metadata-Version: 2.4
Name: csvpeek
Version: 0.10.2
Summary: A snappy CSV viewer TUI - peek at your data fast
Project-URL: Homepage, https://github.com/giantatwork/csvpeek
Project-URL: Repository, https://github.com/giantatwork/csvpeek
Project-URL: Issues, https://github.com/giantatwork/csvpeek/issues
Author-email: Giant at Work <info@giantatwork.nl>
License: MIT
License-File: LICENSE
Keywords: csv,data,duckdb,terminal,tui,urwid,viewer
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: duckdb>=1.1.0
Requires-Dist: pyperclip>=1.8.0
Requires-Dist: urwid>=2.1.0
Description-Content-Type: text/markdown

# csvpeek

> A fast CSV viewer in your terminal - peek at your data instantly ⚡

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Python](https://img.shields.io/badge/python-3.10+-blue.svg)

**Csvpeek** is a snappy, memory-efficient CSV viewer built for speed. Powered by [DuckDB](https://duckdb.org/) for fast SQL-backed querying and [Urwid](https://urwid.org/) for a lean terminal UI.

## Features

- **Fast** - DuckDB streaming with LIMIT/OFFSET keeps startup instant, even with huge files
- **Large File Support** - Pagination handles millions of rows without breaking a sweat
- **Cell Selection** - Select and copy ranges with keyboard shortcuts
- **Column Sorting** - Sort by any column instantly
- **Keyboard-First** - Every action is a keystroke away

## Quick Start

### Installation

```bash
uv tool install csvpeek
```

Or install from source:

```bash
git clone https://github.com/giantatwork/csvpeek.git
cd csvpeek
pip install -e .
```

#### Windows

Install the [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) to ensure DuckDB works on Windows

### Usage

```bash
csvpeek your_data.csv
```

## Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `/` | Open filter dialog |
| `r` | Reset all filters |
| `Ctrl+D` | Next page |
| `Ctrl+U` | Previous page |
| `s` | Sort current column |
| `c` | Copy selection to clipboard |
| `w` | Save selection to file |
| `Shift+Arrow` | Select cells |
| `Arrow Keys` | Navigate (clears selection) |
| `q` | Quit |

## Usage Examples

### Basic Viewing
Open any CSV file and start navigating immediately:
```bash
csvpeek data.csv
```

### Filtering
1. Press `/` to open the filter dialog
2. Enter filter values for any columns
3. Press `Enter` to apply
4. Filter matches are highlighted in red

**Filter modes:**
- **Literal mode**: Case-insensitive substring search (e.g., `scranton` matches "Scranton")
- **Regex mode**: Start with `/` for regex patterns (e.g., `/^J` matches names starting with J)
  - `/\d+` - Contains digits
  - `/sales|eng` - Contains "sales" OR "eng"
  - `/^test$` - Exactly "test"
  - All regex patterns are case-insensitive

### Sorting
1. Navigate to any column
2. Press `s` to sort by that column
3. Press `s` again to toggle ascending/descending

### Selection & Copy
1. Position cursor on starting cell
2. Hold `Shift` and use arrow keys to select a range
3. Press `c` to copy selection as tab-separated values
4. Paste anywhere with `Ctrl+V`



## Requirements
- Python 3.12+
- DuckDB >= 1.1.0
- Urwid >= 2.1.0
- Pyperclip >= 1.9.0

## License

MIT License - see LICENSE file for details

## Acknowledgments

Built with amazing open-source tools:
- [DuckDB](https://duckdb.org/) - Embedded analytics database
- [Urwid](https://urwid.org/) - Lightweight terminal UI toolkit

## Contact

Found a bug? Have a feature request? [Open an issue](https://github.com/giantatwork/csvpeek/issues)!


