Installation

FastAdmin requires Python 3.12+.

Install the package with the extras matching your web framework and ORM:

pipuvpoetry

pip install fastadmin[fastapi,django]        # FastAPI with Django ORM
pip install fastadmin[fastapi,tortoise-orm]  # FastAPI with Tortoise ORM
pip install fastadmin[fastapi,pony]          # FastAPI with Pony ORM
pip install fastadmin[fastapi,sqlalchemy]    # FastAPI with SQLAlchemy (includes greenlet)
pip install fastadmin[fastapi,yara-orm]      # FastAPI with Yara ORM
pip install fastadmin[django]                # Django with Django ORM
pip install fastadmin[django,pony]           # Django with Pony ORM
pip install fastadmin[flask,sqlalchemy]      # Flask with SQLAlchemy (includes greenlet)

uv add 'fastadmin[fastapi,django]'
uv add 'fastadmin[fastapi,tortoise-orm]'
uv add 'fastadmin[fastapi,pony]'
uv add 'fastadmin[fastapi,sqlalchemy]'
uv add 'fastadmin[fastapi,yara-orm]'
uv add 'fastadmin[django]'
uv add 'fastadmin[django,pony]'
uv add 'fastadmin[flask,sqlalchemy]'

poetry add 'fastadmin[fastapi,django]'
poetry add 'fastadmin[fastapi,tortoise-orm]'
poetry add 'fastadmin[fastapi,pony]'
poetry add 'fastadmin[fastapi,sqlalchemy]'
poetry add 'fastadmin[fastapi,yara-orm]'
poetry add 'fastadmin[django]'
poetry add 'fastadmin[django,pony]'
poetry add 'fastadmin[flask,sqlalchemy]'

Tip

On zsh (the default macOS shell), quote the extras: pip install 'fastadmin[fastapi,django]'

Info

When using SQLAlchemy, the greenlet package is required — it is included in the fastadmin[sqlalchemy] extra.

Required settings

Configure the required settings as environment variables:

export ADMIN_USER_MODEL=User
export ADMIN_USER_MODEL_USERNAME_FIELD=username
export ADMIN_SECRET_KEY=secret_key

Info

You can put these variables in a .env file and load them with python-dotenv. See Settings for the full list of options.

Next, follow the Quick start to mount the dashboard and register your first model.