Awesome
django-flyio
A set of simple utilities for Django apps running on Fly.io.
Note: This package is designed to work with V2 Apps. It has not been tested with V1 Apps.
Installation
pip install django-flyio
Usage
Multi-Region Fly Postgres
-
Set your
DATABASES
settings to callget_db_config
fromdjango_flyio.db
.This function reads the
PRIMARY_REGION
andFLY_REGION
environment variables to determine the Fly region the primary database is in and the Fly region the app is currently running in. -
Add
django_flyio.routers.FlyDBReplicaRouter
to yourDATABASE_ROUTERS
settings.This router reads whether the
DATABASES
setting has areplica
key and, if so, routes reads to the replica database.
# settings.py
from django_flyio.db import get_db_config
DATABASES = get_db_config()
DATABASE_ROUTERS = ["django_flyio.routers.FlyDBReplicaRouter"]
Middleware
To set the Fly-Server
header containing the Fly server and region that served the request, add django_flyio.middleware.FlyResponseMiddleware
to your MIDDLEWARE
settings.
# settings.py
MIDDLEWARE = [
# ...
'django_flyio.middleware.FlyResponseMiddleware',
]
License
django-flyio
is distributed under the terms of the MIT license.