• Stars
    star
    5,383
  • Rank 7,664 (Top 0.2 %)
  • Language
    Python
  • License
    MIT License
  • Created almost 3 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

Litestar Logo - Light Litestar Logo - Dark

ci PyPI - Version PyPI - License PyPI - Support Python Versions

Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating

All Contributors

Reddit Discord Matrix Medium

Starlite โ†’ Litestar

Starlite has been renamed to Litestar


Litestar is a powerful, performant, flexible and opinionated ASGI framework, offering first class typing support and a full Pydantic integration.

Check out the documentation ๐Ÿ“š.

Installation

pip install litestar

Litestar 2.0 is coming out soon, bringing many new features and improvements. You can check out the alpha version by instead running

pip install litestar==2.0.0alpha7

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

  • starlite-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-hello-world: A bare-minimum application setup. Great for testing and POC work.

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.

JSON Benchmarks

JSON benchmarks

Plaintext Benchmarks

Plaintext benchmarks

Features

Class Based Controllers

While supporting function based route handlers, Litestar also supports and promotes python OOP using class based controllers:

from typing import List, Optional

from pydantic import UUID4
from litestar import Controller, get, post, put, patch, delete
from litestar.partial import Partial
from datetime import datetime

from my_app.models import User


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}")
    async def partial_update_user(self, user_id: UUID4, data: Partial[User]) -> 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 Pydantic

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 absolutely 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 pydantic-factories 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.

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.

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

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

๐Ÿ’ป

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

More Repositories

1

polyfactory

Simple and powerful factories for mock data generation
Python
1,032
star
2

litestar-fullstack

Litestar Fullstack Reference Application with React, Vite, SQLAlchemy, Docker, Task Queues, and more!
Python
308
star
3

advanced-alchemy

A carefully crafted, thoroughly tested, optimized companion library for SQLAlchemy
Python
222
star
4

litestar-pg-redis-docker

Example Litestar project using Postgresql, Redis and Docker
Python
147
star
5

awesome-litestar

A curated list of resources related to Litestar.
Makefile
67
star
6

api-performance-tests

Benchmarking Litestar vs other ASGI API framework
Python
35
star
7

fast-query-parsers

Ultra-fast query string and url-encoded form-data parsers
Rust
30
star
8

pytest-databases

Reusable database fixtures for any and all databases.
Python
18
star
9

litestar-hello-world-stale

The minimum Litestar application
Python
17
star
10

litestar-vite

Vite Plugin for Litestar
Python
16
star
11

pydantic-factories

Simple and powerful mock data generation using pydantic or dataclasses
Python
13
star
12

starlite-jwt

JWT Auth toolkit for Starlite
Python
12
star
13

pydantic-openapi-schema

Generate OpenAPI 3.x.x using Pydantic
Python
11
star
14

type-lens

Runtime type introspection utilities
Python
11
star
15

litestar-hello-world

A minimal implementation of a Litestar application
Makefile
11
star
16

dtos

Domain modelling at the edge.
Python
10
star
17

project-template

Template repository for packages belonging to the Litestar Organization
Python
9
star
18

starlite-multipart

Toolkit for working with multipart/formdata
Python
8
star
19

vite-plugin

Litestar Adapter for Vite
TypeScript
8
star
20

litestar-asyncpg

Database connection management plugin for Litestar and asyncpg
Python
7
star
21

starlite-sessions

Simple sessions authentication for Starlite
Python
6
star
22

starlite-oidc

OpenID Connect (OIDC) authentication toolkit for Starlite
Python
5
star
23

litestar-oracledb

An Oracle Database plugin for Litestar
Python
5
star
24

starlite-cli

CLI for Starlite
Python
3
star
25

litestar-fullstack-inertia

A fully-functional reference application using Litestar, Inertia JS, and Advanced Alchemy
Python
3
star
26

litestar-piccolo

Litestar plugin for the Piccolo ORM
Python
3
star
27

litestar-oidc

WIP - OIDC Implementation for Litestar applications
Python
2
star
28

litestar.dev

Source code for litestar.dev
HTML
2
star
29

starlite-websockets-hello-world

MInimal example of websockets with Starlite
Python
1
star
30

branding

Branding for the @litestar-org organization and project
CSS
1
star