Litestar Logo - Light Litestar Logo - Dark
Project | Status |
---|---|
CI/CD | Latest Release ci Documentation Building |
Quality | Coverage |
Package | PyPI - Version PyPI - Support Python Versions Starlite PyPI - Downloads Litestar PyPI - Downloads |
Community | Reddit Discord Matrix Medium Twitter Blog |
Meta | Litestar Project types - Mypy License - MIT Litestar Sponsors linting - Ruff code style - Ruff All Contributors |
Litestar is a powerful, flexible yet opinionated ASGI framework, focused on building APIs. It offers high-performance data validation, dependency injection, first-class ORM integration, authorization primitives, a rich plugin API, middleware, and much more that's needed to get applications up and running.
Check out the documentation π for a detailed overview of its features!
Additionally, the Litestar fullstack repository can give you a good impression how a fully fledged Litestar application may look.
Table of Contents
pip install litestar
or to include the CLI and a server (uvicorn) for running your application:
pip install 'litestar[standard]'
from litestar import Litestar, get @get("/") async def hello_world() -> dict[str, str]: """Keeping the tradition alive with hello world.""" return {"hello": "world"} app = Litestar(route_handlers=[hello_world])
And run it with
litestar run
- Class based controllers
- Dependency Injection
- Layered Middleware
- Plugin System
- OpenAPI 3.1 schema generation
- Life Cycle Hooks
- Route Guards based Authorization
- Support for
dataclasses
,TypedDict
,msgspec
, pydantic version 1 and version 2 (even within the same application) and (c)attrs - Layered parameter declaration
- Support for RFC 9457 standardized "Problem Detail" error responses
- Automatic API documentation with:
- Trio support (built-in, via AnyIO)
- Ultra-fast validation, serialization and deserialization using msgspec
- SQLAlchemy integration
Pre-built Example Apps
- litestar-hello-world: A bare-minimum application setup. Great for testing and POC work.
- litestar-fullstack: A reference application that contains most of the boilerplate required for a web application. It features a Litestar app configured with best practices, SQLAlchemy 2.0 and SAQ, a frontend integrated with Vitejs and Jinja2 templates, Docker, and more. Like all Litestar projects, this application is open to contributions, big and small.
Litestar is an open-source project, and we enjoy the support of our sponsors to help fund the exciting work we do.
A huge thanks to our sponsors:
Check out our sponsors in the docs
If you would like to support the work that we do please consider becoming a sponsor via Polar.sh (preferred), GitHub or Open Collective.
Also, exclusively with Polar, you can engage in pledge-based sponsorships.
While supporting function-based route handlers, Litestar also supports and promotes python OOP using class based controllers:
Example for class-based controllers
from typing import List, Optional from datetime import datetime from litestar import Controller, get, post, put, patch, delete from litestar.dto import DTOData from pydantic import UUID4 from my_app.models import User, PartialUserDTO class UserController(Controller): path = "/users" @post() async def create_user(self, data: User) -> User: ... @get() async def list_users(self) -> List[User]: ... @get(path="/{date:int}") async def list_new_users(self, date: datetime) -> List[User]: ... @patch(path="/{user_id:uuid}", dto=PartialUserDTO) async def partial_update_user( self, user_id: UUID4, data: DTOData[PartialUserDTO] ) -> User: ... @put(path="/{user_id:uuid}") async def update_user(self, user_id: UUID4, data: User) -> User: ... @get(path="/{user_name:str}") async def get_user_by_name(self, user_name: str) -> Optional[User]: ... @get(path="/{user_id:uuid}") async def get_user(self, user_id: UUID4) -> User: ... @delete(path="/{user_id:uuid}") async def delete_user(self, user_id: UUID4) -> None: ...
Litestar is rigorously typed, and it enforces typing. For example, if you forget to type a return value for a route handler, an exception will be raised. The reason for this is that Litestar uses typing data to generate OpenAPI specs, as well as to validate and parse data. Thus, typing is essential to the framework.
Furthermore, Litestar allows extending its support using plugins.
Litestar has a plugin system that allows the user to extend serialization/deserialization, OpenAPI generation, and other features.
It ships with a builtin plugin for SQL Alchemy, which allows the user to use SQLAlchemy declarative classes "natively" i.e., as type parameters that will be serialized/deserialized and to return them as values from route handlers.
Litestar also supports the programmatic creation of DTOs with a DTOFactory
class, which also supports the use of
plugins.
Litestar has custom logic to generate OpenAPI 3.1.0 schema, include optional generation of examples using the
polyfactory
library.
Litestar serves the documentation from the generated OpenAPI schema with:
All these are available and enabled by default.
Litestar has a simple but powerful DI system inspired by pytest. You can define named dependencies - sync or async - at different levels of the application, and then selective use or overwrite them.
Example for DI
from litestar import Litestar, get from litestar.di import Provide async def my_dependency() -> str: ... @get("/") async def index(injected: str) -> str: return injected app = Litestar([index], dependencies={"injected": Provide(my_dependency)})
Litestar supports typical ASGI middleware and ships with middlewares to handle things such as
- CORS
- CSRF
- Rate limiting
- GZip, Brotli, and Zstd compression
- Client- and server-side sessions
Litestar has an authorization mechanism called guards
, which allows the user to define guard functions at different
level of the application (app, router, controller etc.) and validate the request before hitting the route handler
function.
Example for route guards
from litestar import Litestar, get from litestar.connection import ASGIConnection from litestar.handlers.base import BaseRouteHandler from litestar.exceptions import NotAuthorizedException async def is_authorized(connection: ASGIConnection, handler: BaseRouteHandler) -> None: # validate authorization # if not authorized, raise NotAuthorizedException raise NotAuthorizedException() @get("/", guards=[is_authorized]) async def index() -> None: ... app = Litestar([index])
Litestar supports request life cycle hooks, similarly to Flask - i.e. before_request
and after_request
Litestar is fast. It is on par with, or significantly faster than comparable ASGI frameworks.
You can see and run the benchmarks here, or read more about it here in our documentation.
Litestar is open to contributions big and small. You can always join our discord server or join our Matrix space to discuss contributions and project maintenance. For guidelines on how to contribute, please see the contribution guide.
Thanks goes to these wonderful people:
Emoji KeyNa'aman Hirschfeld
π§ π» π
Peter Schutt
π§ π» π
Ashwin Vinod
π» π Damian
Damian
π Vincent Sarago
Vincent Sarago
π» Jonas KrΓΌger Svensson
Jonas KrΓΌger Svensson
π¦ Sondre LillebΓΈ Gundersen
Sondre LillebΓΈ Gundersen
π¦
Lev
π» π€ Tim Wedde
Tim Wedde
π» Tory Clasen
Tory Clasen
π» Arseny Boykov
Arseny Boykov
π» π€ Jacob Rodgers
Jacob Rodgers
π‘ Dane Solberg
Dane Solberg
π» madlad33
madlad33
π»
Matthew Aylward
π» Jan Klima
Jan Klima
π» C2D
C2D
to-ph
π» imbev
imbev
π cΔtΔlin
cΔtΔlin
π» Seon82
Seon82
π
Slava
π» Harry
Harry
π» π Cody Fincher
Cody Fincher
π§ π» π
Christian Clauss
π josepdaniel
josepdaniel
π» devtud
devtud
π Nicholas Ramos
Nicholas Ramos
π»
seladb
π π» Simon WienhΓΆfer
Simon WienhΓΆfer
π» MobiusXS
MobiusXS
π» Aidan Simard
Aidan Simard
π wweber
wweber
π» Samuel Colvin
Samuel Colvin
π» Mateusz MikoΕajczyk
Mateusz MikoΕajczyk
π»
Alex
π» Odiseo
Odiseo
π Javier Pinilla
Javier Pinilla
π» Chaoying
Chaoying
π infohash
infohash
π» John Ingles
John Ingles
π» Eugene
Eugene
Jon Daly
π π» Harshal Laheri
Harshal Laheri
π» π TΓ©va KRIEF
TΓ©va KRIEF
π» Konstantin Mikhailov
Konstantin Mikhailov
π§ π» π
Mitchell Henry
π chbndrhnns
chbndrhnns
π nielsvanhooy
nielsvanhooy
π» π
provinzkraut
π§ π» π
Joshua Bronson
π Roman Reznikov
Roman Reznikov
π mookrs
mookrs
π Mike DePalatis
Mike DePalatis
π Carlos Alberto PΓ©rez-Molano
Carlos Alberto PΓ©rez-Molano
π ThinksFast
ThinksFast
Christopher Krause
π» Kyle Smith
Kyle Smith
π» π π Scott Bradley
Scott Bradley
π Srikanth Chekuri
Srikanth Chekuri
Michael Bosch
π sssssss340
sssssss340
π ste-pool
ste-pool
π» π
Alc-Alc
π π»
asomethings
π» Garry Bullock
Garry Bullock
π Niclas Haderer
Niclas Haderer
π» Diego Alvarez
Diego Alvarez
π π»
Jason Nance
π Igor Kapadze
Igor Kapadze
π
Somraj Saha
π MagnΓΊs ΓgΓΊst SkΓΊlason
MagnΓΊs ΓgΓΊst SkΓΊlason
π» π Alessio Parma
Alessio Parma
π Peter Brunner
Peter Brunner
π» Jacob Coffee
Jacob Coffee
π π»
Gamazic
π» Kareem Mahlees
Kareem Mahlees
π»
Abdulhaq Emhemmed
π» π Jenish
Jenish
π» π chris-telemetry
chris-telemetry
π» Ward
Ward
π Stephan Fitzpatrick
Stephan Fitzpatrick
π Eric Kennedy
Eric Kennedy
π wassaf shahzad
wassaf shahzad
π»
Nils Olsson
π» π Riley Chase
Riley Chase
π» arl
arl
π§ Antoine van der Horst
Antoine van der Horst
π Nick Groenen
Nick Groenen
π Giorgio Vilardo
Giorgio Vilardo
π Nicholas Bollweg
Nicholas Bollweg
π»
Tomas Jonsson
Khiem Doan
π kedod
kedod
π π»
sonpro1296
π»
Patrick Armengol
π Sander
Sander
π η―δΊΊι’δΈ»δ»»
η―δΊΊι’δΈ»δ»»
π
aviral-nayya
π» whiskeyriver
whiskeyriver
π» Phyo Arkar Lwin
Phyo Arkar Lwin
π» MatthewNewland
MatthewNewland
π π»
Tom Kuo
π LeckerenSirupwaffeln
LeckerenSirupwaffeln
π Daniel GonzΓ‘lez FernΓ‘ndez
Daniel GonzΓ‘lez FernΓ‘ndez
π
01EK98
π Sarbo Roy
Sarbo Roy
π» Ryan Seeley
Ryan Seeley
π» Felix
Felix
π π George Sakkis
George Sakkis
π» Huba Tuba
Huba Tuba
π π»
Stefane Fermigier
π
r4ge
π» π Jay
Jay
π» sinisaos
sinisaos
π Tharuka Devendra
Tharuka Devendra
π» euri10
euri10
π» π π Shubham
Shubham
π Erik Hasse
Erik Hasse
π π»
Nikita Sobolev
π π» Nguyα» n HoΓ ng Δα»©c
Nguyα» n HoΓ ng Δα»©c
π RavanaBhrama
RavanaBhrama
π Marcel Johannesmann
Marcel Johannesmann
π Matthew
Matthew
π Mattwmaster58
Mattwmaster58
π π»
Manuel Sanchez Pinar
π
Juan Riveros
π David Brochart
David Brochart
π Sean Donoghue
Sean Donoghue
π P.C. Shyamshankar
P.C. Shyamshankar
π π»
William Evonosky
π» geeshta
geeshta
π π» π Robert Rosca
Robert Rosca
π
DICE_Lab
π» Luis San Pablo
Luis San Pablo
π»
Pastukhov Nikita
π James O'Claire
James O'Claire
π Pete
Pete
π Alexandre Richonnier
Alexandre Richonnier
π» π betaboon
betaboon
π»
Dennis Brakhane
π» π Pragy Agarwal
Pragy Agarwal
π Piotr Dybowski
Piotr Dybowski
π Konrad Szczurek
Konrad Szczurek
π
Orell Garten
π» π
Julien
π Leejay Hsu
Leejay Hsu
π§ π π
Michiel W. Beijen
π L. Bao
L. Bao
π Jarred Glaser
Jarred Glaser
π Hunter Boyd
Hunter Boyd
π Cesar Giulietti
Cesar Giulietti
π Marcus Lim
Marcus Lim
π Henry Zhou
Henry Zhou
π π»
William Stam
π andrew do
andrew do
π»
Boseong Choi
π»
Kim Minki
π» π Jeongseop Lim
Jeongseop Lim
π FergusMok
FergusMok
π π»
Manu Singhal
π
Jerry Wu
π horo
horo
π Ross Titmarsh
Ross Titmarsh
π» Mike Korneev
Mike Korneev
π Patrick Neise
Patrick Neise
π» Jean Arhancet
Jean Arhancet
π Leo Alekseyev
Leo Alekseyev
π»
aranvir
π π»
bunny-therapist
π» Ben Luo
Ben Luo
π Hugo van Kemenade
Hugo van Kemenade
π Michael Gerbig
Michael Gerbig
π CrisOG
CrisOG
π π»
harryle
π»
James Bennett
π sherbang
sherbang
π Carl Smedstad
Carl Smedstad
Taein Min
π Stanislav Lyu.
Stanislav Lyu.
π Tibor Reiss
Tibor Reiss
Alex
π π»
Joren Six
π jderrien
jderrien
π PossiblePanda
PossiblePanda
π evstrat
evstrat
π Ikko Eltociear Ashimine
Ikko Eltociear Ashimine
π Taimur Ibrahim
Taimur Ibrahim
π l-armstrong
l-armstrong
π
Anuranjan Srivastava
π» Simon Joseph
Simon Joseph
π Abel Kidanemariam
Abel Kidanemariam
π»
Trim21
π»
Agustin Arce
π Farhan Ali Raza
Farhan Ali Raza
π Fabian
Fabian
π»
This project follows the all-contributors specification. Contributions of any kind welcome!