litestar-org / litestar

Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs

Home Page:https://litestar.dev/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Litestar Logo - Light Litestar Logo - Dark

Project Status
CI/CD Latest Release ci Documentation Building
Quality Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating
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, and offers high-performance data validation and parsing, dependency injection, first-class ORM integration, authorization primitives, 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

Installation

pip install litestar

Quick Start

from litestar import Litestar, get


@get("/")
def hello_world() -> dict[str, str]:
    """Keeping the tradition alive with hello world."""
    return {"hello": "world"}


app = Litestar(route_handlers=[hello_world])

Core Features

Example Applications

Pre-built Example Apps
  • litestar-pg-redis-docker: In addition to Litestar, this demonstrates a pattern of application modularity, SQLAlchemy 2.0 ORM, Redis cache connectivity, and more. Like all Litestar projects, this application is open to contributions, big and small.
  • 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.
  • litestar-hello-world: A bare-minimum application setup. Great for testing and POC work.

Sponsors

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:

Scalar.com Telemetry Sports Stok

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.

Features

Class-based Controllers

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: ...

Data Parsing, Type Hints, and Msgspec

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.

Plugin System, ORM support, and DTOs

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.

OpenAPI

Litestar has custom logic to generate OpenAPI 3.1.0 schema, include optional generation of examples using the polyfactory library.

ReDoc, Swagger-UI and Stoplight Elements API Documentation

Litestar serves the documentation from the generated OpenAPI schema with:

All these are available and enabled by default.

Dependency Injection

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)})

Middleware

Litestar supports typical ASGI middleware and ships with middlewares to handle things such as

  • CORS
  • CSRF
  • Rate limiting
  • GZip and Brotli compression
  • Client- and server-side sessions

Route Guards

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])

Request Life Cycle Hooks

Litestar supports request life cycle hooks, similarly to Flask - i.e. before_request and after_request

Performance

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.

Contributing

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.

Contributors ✨

Thanks goes to these wonderful people: Emoji Key
Na'aman Hirschfeld
Na'aman Hirschfeld

🚧 πŸ’» πŸ“– ⚠️ πŸ€” πŸ’‘ πŸ›
Peter Schutt
Peter Schutt

🚧 πŸ’» πŸ“– ⚠️ πŸ€” πŸ’‘ πŸ›
Ashwin Vinod
Ashwin Vinod

πŸ’» πŸ“–
Damian
Damian

πŸ“–
Vincent Sarago
Vincent Sarago

πŸ’»
Jonas KrΓΌger Svensson
Jonas KrΓΌger Svensson

πŸ“¦
Sondre LillebΓΈ Gundersen
Sondre LillebΓΈ Gundersen

πŸ“¦
Lev
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
Matthew Aylward

πŸ’»
Jan Klima
Jan Klima

πŸ’»
C2D
C2D

⚠️
to-ph
to-ph

πŸ’»
imbev
imbev

πŸ“–
cătălin
cătălin

πŸ’»
Seon82
Seon82

πŸ“–
Slava
Slava

πŸ’»
Harry
Harry

πŸ’» πŸ“–
Cody Fincher
Cody Fincher

🚧 πŸ’» πŸ“– ⚠️ πŸ€” πŸ’‘ πŸ›
Christian Clauss
Christian Clauss

πŸ“–
josepdaniel
josepdaniel

πŸ’»
devtud
devtud

πŸ›
Nicholas Ramos
Nicholas Ramos

πŸ’»
seladb
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
Alex

πŸ’»
Odiseo
Odiseo

πŸ“–
Javier  Pinilla
Javier Pinilla

πŸ’»
Chaoying
Chaoying

πŸ“–
infohash
infohash

πŸ’»
John Ingles
John Ingles

πŸ’»
Eugene
Eugene

⚠️ πŸ’»
Jon Daly
Jon Daly

πŸ“– πŸ’»
Harshal Laheri
Harshal Laheri

πŸ’» πŸ“–
TΓ©va KRIEF
TΓ©va KRIEF

πŸ’»
Konstantin Mikhailov
Konstantin Mikhailov

🚧 πŸ’» πŸ“– ⚠️ πŸ€” πŸ’‘ πŸ›
Mitchell Henry
Mitchell Henry

πŸ“–
chbndrhnns
chbndrhnns

πŸ“–
nielsvanhooy
nielsvanhooy

πŸ’» πŸ› ⚠️
provinzkraut
provinzkraut

🚧 πŸ’» πŸ“– ⚠️ πŸ€” πŸ’‘ πŸ› 🎨
Joshua Bronson
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
Christopher Krause

πŸ’»
Kyle Smith
Kyle Smith

πŸ’» πŸ“– πŸ›
Scott Bradley
Scott Bradley

πŸ›
Srikanth Chekuri
Srikanth Chekuri

⚠️ πŸ“–
Michael Bosch
Michael Bosch

πŸ“–
sssssss340
sssssss340

πŸ›
ste-pool
ste-pool

πŸ’» πŸš‡
Alc-Alc
Alc-Alc

πŸ“– πŸ’» ⚠️ πŸš‡
asomethings
asomethings

πŸ’»
Garry Bullock
Garry Bullock

πŸ“–
Niclas Haderer
Niclas Haderer

πŸ’»
Diego Alvarez
Diego Alvarez

πŸ“– πŸ’» ⚠️
Jason Nance
Jason Nance

πŸ“–
Igor Kapadze
Igor Kapadze

πŸ“–
Somraj Saha
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
Gamazic

πŸ’»
Kareem Mahlees
Kareem Mahlees

πŸ’»
Abdulhaq Emhemmed
Abdulhaq Emhemmed

πŸ’» πŸ“–
Jenish
Jenish

πŸ’» πŸ“–
chris-telemetry
chris-telemetry

πŸ’»
Ward
Ward

πŸ›
Stephan Fitzpatrick
Stephan Fitzpatrick

πŸ›
Eric Kennedy
Eric Kennedy

πŸ“–
wassaf shahzad
wassaf shahzad

πŸ’»
Nils Olsson
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
Tomas Jonsson

⚠️ πŸ’»
Khiem Doan
Khiem Doan

πŸ“–
kedod
kedod

πŸ“– πŸ’» ⚠️
sonpro1296
sonpro1296

πŸ’» ⚠️ πŸš‡ πŸ“–
Patrick Armengol
Patrick Armengol

πŸ“–
Sander
Sander

πŸ“–
η–―δΊΊι™’δΈ»δ»»
η–―δΊΊι™’δΈ»δ»»

πŸ“–
aviral-nayya
aviral-nayya

πŸ’»
whiskeyriver
whiskeyriver

πŸ’»
Phyo Arkar Lwin
Phyo Arkar Lwin

πŸ’»
MatthewNewland
MatthewNewland

πŸ› πŸ’» ⚠️
Tom Kuo
Tom Kuo

πŸ›
LeckerenSirupwaffeln
LeckerenSirupwaffeln

πŸ›
Daniel GonzΓ‘lez FernΓ‘ndez
Daniel GonzΓ‘lez FernΓ‘ndez

πŸ“–
01EK98
01EK98

πŸ“–
Sarbo Roy
Sarbo Roy

πŸ’»
Ryan Seeley
Ryan Seeley

πŸ’»
Felix
Felix

πŸ“– πŸ›
George Sakkis
George Sakkis

πŸ’»
Huba Tuba
Huba Tuba

πŸ“–
Stefane Fermigier
Stefane Fermigier

πŸ“–
r4ge
r4ge

πŸ’» πŸ“–
Jay
Jay

πŸ’»
sinisaos
sinisaos

πŸ“–
Tharuka Devendra
Tharuka Devendra

πŸ’»
euri10
euri10

πŸ’» πŸ“– πŸ›
Shubham
Shubham

πŸ“–
Erik Hasse
Erik Hasse

πŸ› πŸ’»
Nikita Sobolev
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
Manuel Sanchez Pinar

πŸ“–
Juan Riveros
Juan Riveros

πŸ“–
David Brochart
David Brochart

πŸ“–
Sean Donoghue
Sean Donoghue

πŸ“–
P.C. Shyamshankar
P.C. Shyamshankar

πŸ› πŸ’» ⚠️
William Evonosky
William Evonosky

πŸ’»
geeshta
geeshta

πŸ“– πŸ’» πŸ›
Robert Rosca
Robert Rosca

πŸ“–
DICE_Lab
DICE_Lab

πŸ’»
Luis San Pablo
Luis San Pablo

πŸ’» ⚠️ πŸ“–
Pastukhov Nikita
Pastukhov Nikita

πŸ“–
James O'Claire
James O'Claire

πŸ“–
Pete
Pete

πŸ“–
Alexandre Richonnier
Alexandre Richonnier

πŸ’» πŸ“–
betaboon
betaboon

πŸ’»
Dennis Brakhane
Dennis Brakhane

πŸ’» πŸ›
Pragy Agarwal
Pragy Agarwal

πŸ“–
Piotr Dybowski
Piotr Dybowski

πŸ“–
Konrad Szczurek
Konrad Szczurek

πŸ“– ⚠️
Orell Garten
Orell Garten

πŸ’» πŸ“– ⚠️
Julien
Julien

πŸ“–
Leejay Hsu
Leejay Hsu

🚧 πŸš‡ πŸ“–
Michiel W. Beijen
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
William Stam

πŸ“–
andrew do
andrew do

πŸ’» ⚠️ πŸ“–
Boseong Choi
Boseong Choi

πŸ’» ⚠️
Kim Minki
Kim Minki

πŸ’» πŸ“–
Jeongseop Lim
Jeongseop Lim

πŸ“–
FergusMok
FergusMok

πŸ“– πŸ’» ⚠️
Manu Singhal
Manu Singhal

πŸ“–
Jerry Wu
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
aranvir

πŸ“–
bunny-therapist
bunny-therapist

πŸ’»
Ben Luo
Ben Luo

πŸ“–
Hugo van Kemenade
Hugo van Kemenade

πŸ“–
Michael Gerbig
Michael Gerbig

πŸ“–
CrisOG
CrisOG

πŸ› πŸ’» ⚠️
harryle
harryle

πŸ’» ⚠️
James Bennett
James Bennett

πŸ›
sherbang
sherbang

πŸ“–
Carl Smedstad
Carl Smedstad

⚠️
Taein Min
Taein Min

πŸ“–
Stanislav Lyu.
Stanislav Lyu.

πŸ›
Tibor Reiss
Tibor Reiss

⚠️ πŸ“– πŸ’»
Alex
Alex

πŸ› πŸ’»
Joren Six
Joren Six

πŸ“–
jderrien
jderrien

πŸ“–
PossiblePanda
PossiblePanda

πŸ“–
evstrat
evstrat

πŸš‡
Ikko Eltociear Ashimine
Ikko Eltociear Ashimine

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs

https://litestar.dev/

License:MIT License


Languages

Language:Python 99.6%Language:Makefile 0.2%Language:HTML 0.1%Language:CSS 0.1%Language:JavaScript 0.0%Language:Lua 0.0%Language:Dockerfile 0.0%