Skip to content

🚀 Installation

FastAPI Cachekit is designed to be easy to install and flexible for any workflow.
You can use pip, uv, or poetry and only install the backends you need.

📦 Basic Installation (In-Memory Only)

Install the core package (in-memory backend only):

  • pip pip install fastapi-cachekit
  • uv uv add fastapi-cachekit
  • poetry poetry add fastapi-cachekit

🔌 Optional Backends

You can install support for Redis, Postgres, MongoDB, Memcached, Firestore, DynamoDB by specifying the appropriate "extra".

Redis Backend

  • pip pip install fastapi-cachekit[redis]
  • uv uv add fastapi-cachekit[redis]
  • poetry poetry add fastapi-cachekit -E redis

Postgres Backend

  • pip pip install fastapi-cachekit[postgres]
  • uv uv add fastapi-cachekit[postgres]
  • poetry poetry add fastapi-cachekit -E postgres

Memcached Backend

  • pip pip install fastapi-cachekit[memcached]
  • uv uv add fastapi-cachekit[memcached]
  • poetry poetry add fastapi-cachekit -E memcached

MongoDB Backend

  • pip pip install fastapi-cachekit[mongodb]
  • uv uv add fastapi-cachekit[mongodb]
  • poetry poetry add fastapi-cachekit -E mongodb

FireStore Backend

  • pip pip install fastapi-cachekit[firestore]
  • uv uv add fastapi-cachekit[firestore]
  • poetry poetry add fastapi-cachekit -E firestore

DynamoDB Backend

  • pip pip install fastapi-cachekit[dynamodb]
  • uv uv add fastapi-cachekit[dynamodb]
  • poetry poetry add fastapi-cachekit -E dynamodb

🧩 Install All Backends

If you want to install all supported backends at once:

  • pip pip install fastapi-cachekit[all]

  • uv uv add fastapi-cachekit[all]

  • poetry poetry add fastapi-cachekit -E all

🛠️ Development & Testing

For development (with test and dev dependencies):

  • uv 
    uv sync --all-group
  • poetry 
    poetry install --with dev

⚡️ Notes

  • You only need to install the backend(s) you plan to use.
  • All backends support both sync and async APIs.

Next: Usage Guide →