Skip to content

Installation

This documentation describes filestore 2.0.0. Existing 1.x applications should review Migrating from 1.x before upgrading.

Base Package

Install filestore with pip:

pip install filestore

For reproducible environments, pin the release explicitly:

pip install "filestore==2.0.0"

Or with uv:

uv add filestore

The base install includes the local filesystem and in-memory storage engines with no additional dependencies beyond FastAPI itself (Pydantic ships with FastAPI).

Cloud Storage Extras

Cloud engines are installed as optional extras so the base package stays lean.

pip install "filestore[s3]"

Installs boto3 for S3 and S3-compatible services (MinIO, LocalStack, etc.).

pip install "filestore[gcp]"

Installs google-cloud-storage for GCS.

pip install "filestore[azure]"

Installs azure-storage-blob and azure-identity for Azure Blob Storage.

Multiple Extras

Install multiple extras at once, or everything:

pip install "filestore[s3,gcp]"
pip install "filestore[all]"

Requirements

  • Python ≥ 3.11
  • FastAPI ≥ 0.120.0

Verify Installation

import filestore
print(filestore.__version__)