Skip to content

Installation

Install starlette-admin using your preferred package manager.

pip install starlette-admin

uv add starlette-admin

starlette-admin requires Python 3.11 or later.

The core package is backend-agnostic. To build an admin interface for your application, install the appropriate integration for your data layer (such as SQLAlchemy, Beanie, MongoEngine, or Tortoise ORM) alongside the base package.

Included dependencies

The base installation includes everything required to run the admin interface. No optional dependencies are installed by default.

Dependency Purpose
Starlette Hosts the admin application.
Jinja2 Provides the template engine for list, detail, and form pages.
python-multipart Parses form submissions and file uploads.
itsdangerous Signs cookies for CSRF tokens and flash messages.

Applications built with FastAPI require no additional integration because FastAPI is built on Starlette. Mount the admin interface to your existing FastAPI application.

Optional dependencies

starlette-admin provides the following optional dependencies:

  • pdf: Adds PDF export support (reportlab).
  • i18n: Adds internationalization support (Babel).
  • tinymce: Adds rich text editor support. Installs nh3, which sanitizes HTML submitted by TinyMCEEditorField.
  • s3: Adds S3-compatible object storage support. Installs aiobotocore for asynchronous uploads to AWS S3 and compatible object storage services, such as MinIO.

Install one or more optional dependencies together with starlette-admin:

# Install the `pdf` extra.
pip install "starlette-admin[pdf]"

# Install multiple extras.
pip install "starlette-admin[i18n,pdf,s3]"

# Install the `pdf` extra.
uv add "starlette-admin[pdf]"

# Install multiple extras.
uv add "starlette-admin[i18n,pdf,s3]"

Install from source

To use the latest unreleased changes, install the package directly from the GitHub repository.

pip install "git+https://github.com/jowilf/starlette-admin.git"

uv add "git+https://github.com/jowilf/starlette-admin.git"

Next steps

  • Quickstart: Build your first admin interface with real data.
  • Concepts: Learn the core architecture and design principles behind starlette-admin.