Skip to content

Installation

Base Package

Install filestore with pip:

pip install filestore

Or with uv:

uv add filestore

The base install includes the local filesystem and in-memory storage backends with no additional dependencies beyond FastAPI itself.

Cloud Storage Extras

Cloud backends 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.

Optional Extras

pip install "filestore[pydantic]"

Enables the FileModel() helper that generates a Pydantic model from your upload field definitions.

Multiple Extras

Install multiple extras at once:

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

Requirements

  • Python ≥ 3.11
  • FastAPI ≥ 0.120.0

Verify Installation

import filestore
print(filestore.__version__)