snapfs 0.4.0

SnapFS Python client and CLI

SnapFS (Python Client)

SnapFS is a file indexing and metadata system designed for large-scale production environments such as VFX, animation, gaming, simulation, and data pipelines.

Status

Early development.

APIs, schemas, and endpoints may evolve rapidly before the 1.0 release.

Features

• Filesystem scanning and metadata ingestion
• Cache-aware incremental hashing
• Async gateway client built on aiohttp
• Command-line interface for common operations

Installation

pip install snapfs

or install from source:

pip install -e .

Install The Systemd Agent

For Linux hosts that should run the SnapFS scanner agent as a service:

git clone https://github.com/snapfsio/snapfs
cd snapfs
pip install .
./systemd/install.sh

The installer expects the snapfs CLI to already be installed and available in PATH. Run the installer as your normal user; it will prompt for elevated privileges when it reaches the root-only systemd setup steps.

For production service installs, prefer installing snapfs into a stable system-level Python environment rather than a user-local virtualenv.

Current systemd installer support is Linux-only. Windows service support is planned but not available yet.

Development

Install developer dependencies:

pip install -e .[dev]

Run the test suite:

pytest -q

Quick Start

Scan a directory and publish metadata:

snapfs scan /mnt/projects

Requirements

• Python 3.8+