Metadata-Version: 2.5
Name: fsspec-browser
Version: 0.4.0
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.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.11
Requires-Dist: fsspec
Requires-Dist: fsspec-data>=0.6.0
Requires-Dist: fsspec-rs<0.3,>=0.2.1
Provides-Extra: database
Requires-Dist: fsspec-db[duckdb]; extra == 'database'
Requires-Dist: pandas; extra == 'database'
Requires-Dist: superstore; extra == 'database'
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>=0.1.4; extra == 'develop'
Requires-Dist: hatch-rs>=0.4.3; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-myst; 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

Browse fsspec filesystems in a terminal or local web UI.

[![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)

`fsspec-browser` lists files, shows metadata, previews data, and downloads objects.
The terminal application supports native local and S3 access plus a Python fsspec
bridge. The web server uses installed Python fsspec backends.

![Web browser](docs/img/browser.png)

![Terminal browser](docs/img/terminal.png)

## Documentation

[Preview local data](docs/src/tutorial.md) is a guided first session.
[Use the terminal](docs/src/terminal.md) or [connect the web browser](docs/src/web.md)
for remote storage, database previews, and downloads.

The [command-line reference](docs/src/cli.md) lists flags, defaults, keys, and
preview limits. The [Python API reference](docs/src/api.md) covers embedding.
Read [Why browsing and previewing are separate operations](docs/src/explanation.md)
for backend boundaries and paging costs.
