Metadata-Version: 2.1
Name: databrowser
Version: 0.1.2
Summary: Quick tool to browse and view data files (json,csv,parquet,more) on local disk and s3
Home-page: https://github.com/jverhoeks/databrowser
License: MIT
Author: Jacob Verhoeks
Author-email: jacob.verhoeks@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pandas (>=1.3.5,<2.0.0)
Requires-Dist: pyarrow (>=5.0.0)
Requires-Dist: s3fs[boto3] (>=2023.3.0,<2024.0.0)
Requires-Dist: s3path (>=0.4.1,<0.5.0)
Requires-Dist: textual (>=0.16.0,<0.17.0)
Project-URL: Repository, https://github.com/jverhoeks/databrowser
Description-Content-Type: text/markdown

# databrowser

A easy file browser to view data files.

Currently supports parquet,json and csv with the Pandas library

_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

Execute `poetry install` to install the package and the dependencies

Run `python3 src/databrowser/data_browser.py`
or run `poetry run databrowser` to execute in virtual env

## Usage

`python3 data_browser.py [optional path]`

_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

## examples

![Screenshot data](images/screenshot_data.svg)

![Screenshot dtype](images/screenshot_dtype.svg)

