Metadata-Version: 2.5
Name: fsspec-fuse
Version: 0.1.0
Summary: Mount fsspec filesystems with FUSE
Project-URL: Repository, https://github.com/1kbgz/fsspec-fuse
Project-URL: Homepage, https://github.com/1kbgz/fsspec-fuse
Author-email: the fsspec-fuse authors <dev@1kbgz.com>
License: Apache-2.0
License-File: LICENSE
Keywords: filesystem,fsspec,fuse,mount
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-rs<0.3,>=0.2.1
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; 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-fuse

Mount fsspec filesystems with FUSE

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

## Overview

`fsspec-fuse` mounts an fsspec URL as a read-only local directory, so any program can
list and read it with ordinary file operations.

```bash
fsspec-fuse s3://my-bucket/reports /mnt/reports -o region=us-east-1
ls /mnt/reports
```

URLs resolve through the filesystem registry that [fsspec-rs](https://github.com/1kbgz/fsspec-rs)
shares between extensions. Native backends (`file://`, `s3://`, and protocols registered by
packages such as fsspec-db and fsspec-kafka) run in Rust. Any other protocol falls back to
the Python fsspec implementation installed for it, such as gcsfs or adlfs.

From Python, `mount` returns a handle that unmounts on `unmount()` or when its `with` block
ends:

```python
import os

from fsspec_fuse import mount

with mount("s3://my-bucket/reports", "/mnt/reports", region="us-east-1"):
    print(os.listdir("/mnt/reports"))
```

Storage options pass to the backend as strings. `threads` sets how many requests the mount
serves at once (default 4).

## Requirements

- Linux: FUSE 3 (`fusermount3`, from the `fuse3` package on Debian and Ubuntu).
- macOS: [macFUSE](https://macfuse.github.io).
- Windows is not supported yet.

Mounts are read-only. Writes, creating files, and renames fail with `EROFS`.

## Documentation

Start with [Mount a directory and read it](docs/src/tutorial.md).
[Mount a remote filesystem](docs/src/how-to.md) covers S3, Python-only backends,
concurrency, and stale mounts.

Look up the [command line](docs/src/cli.md), the [Python API](docs/src/api.md), or
[mount behavior](docs/src/mounts.md) such as attributes and error codes.
[How one mount reaches Rust and Python backends](docs/src/explanation.md) covers the
design and its costs.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
