Metadata-Version: 2.4
Name: databrowser
Version: 1.0.1
Summary: Quick tool to browse and view data files (json,csv,parquet,more) on local disk and s3
Project-URL: repository, https://github.com/jverhoeks/databrowser
Author-email: Jacob Verhoeks <jacob.verhoeks@gmail.com>
License: MIT
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: beautifulsoup4>=4.14.0
Requires-Dist: html5lib>=1.1
Requires-Dist: lxml>=6.1.0
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pandas>=3.0.0
Requires-Dist: pyarrow>=24.0.0
Requires-Dist: s3fs>=2026.4.0
Requires-Dist: s3path>=0.6.2
Requires-Dist: textual>=8.2.0
Requires-Dist: xlrd>=2.0.2
Description-Content-Type: text/markdown

# databrowser

[![PyPI version](https://img.shields.io/pypi/v/databrowser.svg)](https://pypi.org/project/databrowser/)
[![Python versions](https://img.shields.io/pypi/pyversions/databrowser.svg)](https://pypi.org/project/databrowser/)

A terminal file browser for quickly viewing data files, from local disk or S3.

Supports csv, parquet, json, xlsx, xls, xml and html — read into pandas DataFrames
and shown in a scrollable table (with a dtype view). Built on
[Textual](https://textual.textualize.io/).

_Originally based on the example code_browser from Textual._

## install

The package is published on pypi <https://pypi.org/project/databrowser/>

run `pip install databrowser`  (`pip install databrowser --upgrade` to get latest version)

Then just execute `databrowser`

## Build

This project uses [uv](https://docs.astral.sh/uv/) (Python >= 3.13).

Execute `uv sync` to create the virtual env and install the package and its dependencies.

Run `uv run databrowser` to execute in the virtual env
(or `uv run python src/databrowser/data_browser.py`).

## Usage

`databrowser [optional path]` (defaults to the current directory)

_S3 Support_

with the help of S3Path and S3fs the browser now supports s3.

use `databrowser s3://` to start browsing buckets

or `databrowser s3://bucket/path/subdir/` to browse a specific directory.

it uses the default aws credentials in the environment

Select a data file to view

* press F to hide the filebrowser
* press D to show the dtypes
* press S to save a screenshot in svg

* press Q to quit

By default the preview shows the first 100 rows. Set `DATABROWSER_ROWS` to change it,
e.g. `DATABROWSER_ROWS=500 databrowser data/`.

## examples

![Screenshot data](https://raw.githubusercontent.com/jverhoeks/databrowser/main/images/screenshot_data.svg)

![Screenshot dtype](https://raw.githubusercontent.com/jverhoeks/databrowser/main/images/screenshot_dtype.svg)
