Metadata-Version: 2.5
Name: fsspec-rs
Version: 0.1.7
Summary: fsspec-compatible backends with Rust acceleration
Project-URL: Repository, https://github.com/1kbgz/fsspec-rs
Project-URL: Homepage, https://github.com/1kbgz/fsspec-rs
Author-email: the fsspec-rs 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.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-rs>=0.4.3; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: laxate; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-frontmatter; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-benchmark; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: s3fs; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Requires-Dist: yardang; extra == 'develop'
Description-Content-Type: text/markdown

# fsspec-rs

Use Rust-backed local and S3 filesystems through fsspec.

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

`fsspec-rs` provides Python classes that inherit from `fsspec.AbstractFileSystem`
and delegate core I/O to Rust. The native Rust crate provides shared filesystem
traits, local and S3 backends, and read caches. A separate bridge crate adapts
Python fsspec implementations for Rust callers.

## Documentation

Start with [Read and write a local file](docs/src/tutorial.md) for a Python example.
[Use Rust-backed filesystems](docs/src/how-to.md) covers backend selection, S3
endpoints, and caching. [Use the Rust crates](docs/src/how-to-rust.md) covers native
and Python-backed Rust access.

Look up [filesystem behavior](docs/src/filesystems.md),
[Rust traits and types](docs/src/rust.md), or the [Python API](docs/src/api.md).
[Why fsspec-rs uses explicit protocols and shared traits](docs/src/explanation.md)
explains the design decisions.

For source installations, follow [How to build from source](docs/src/how-to-build.md).
[License bundle reference](docs/src/licenses.md) describes which dependency licenses
are included in wheels.
