Metadata-Version: 2.4
Name: fsspec-browser
Version: 0.1.1
Summary: terminal and web browser for fsspec backends
Project-URL: Repository, https://github.com/1kbgz/fsspec-browser
Project-URL: Homepage, https://github.com/1kbgz/fsspec-browser
Author-email: the fsspec-browser authors <dev@1kbgz.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
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 :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Rust
Requires-Python: >=3.10
Requires-Dist: fsspec
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: cibuildwheel; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatch-js; extra == 'develop'
Requires-Dist: hatch-rs; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# fsspec-browser

Terminal and web browser for fsspec-backed filesystems.

[![Build Status](https://github.com/1kbgz/fsspec-browser/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/fsspec-browser/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/1kbgz/fsspec-browser/branch/main/graph/badge.svg)](https://codecov.io/gh/1kbgz/fsspec-browser)
[![License](https://img.shields.io/github/license/1kbgz/fsspec-browser)](https://github.com/1kbgz/fsspec-browser)
[![PyPI](https://img.shields.io/pypi/v/fsspec-browser.svg)](https://pypi.python.org/pypi/fsspec-browser)

## Overview

`fsspec-browser` lets you inspect local files, object stores, and other fsspec-compatible filesystems from a terminal UI or a local web UI. It is built for browsing, previewing, and downloading files without writing one-off scripts.

![fsspec-browser web UI](docs/img/browser.png)

![fsspec-browser terminal UI](docs/img/terminal.png)

## Install

```bash
pip install fsspec-browser
```

Install any fsspec backend packages your URLs require, such as S3, GCS, SSH, or cloud vendor integrations.

## Terminal Browser

```bash
fsspec-browser /tmp
fsspec-browser s3-rs://my-bucket/path -o endpoint_url=https://...
```

Use arrow keys or `j`/`k` to move, `Enter` to open directories, `p` to preview remote files, and `d` to download the selected file.

## Web Browser

```bash
fsspec-browser-web /tmp --host 127.0.0.1 --port 8765
fsspec-browser-web --host 127.0.0.1 --port 8765
```

When started without a path, the web UI opens a connection form. File previews are explicit and bounded by `--preview-bytes`.

## Documentation

See the full docs for terminal usage, web usage, and Python API reference.
