Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork482
Light, flexible and extensible ASGI framework | Built to scale
License
litestar-org/litestar
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
| Project | Status | |
|---|---|---|
| CI/CD |    | |
| Quality |  | |
| Package | ||
| Community | ||
| Meta |     |
Litestar is a powerful, flexible yet opinionated ASGI framework, focused onbuilding 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 thedocumentation 📚 for a detailed overview ofits features!
Additionally, theLitestar fullstack repositorycan 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]'fromlitestarimportLitestar,get@get("/")asyncdefhello_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 forRFC 9457 standardized "Problem Detail" error responses
- Automatic API documentation with:
- Trio support (built-in, viaAnyIO)
- Ultra-fast validation, serialization and deserialization usingmsgspec
- SQLAlchemy integration
Pre-built Example Apps
- litestar-hello-world: A bare-minimum application setup. Greatfor 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 allLitestar 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 excitingwork we do.
Ahuge thanks to our sponsors:
Check out our sponsors in the docs
If you would like to support the work that we do please considerbecoming a sponsorviaPolar.sh (preferred),GitHub orOpen Collective.
Also, exclusively withPolar, you can engage in pledge-based sponsorships.
While supporting function-based route handlers, Litestar also supports and promotes python OOP using class basedcontrollers:
Example for class-based controllers
fromtypingimportList,OptionalfromdatetimeimportdatetimefromlitestarimportController,get,post,put,patch,deletefromlitestar.dtoimportDTODatafrompydanticimportUUID4frommy_app.modelsimportUser,PartialUserDTOclassUserController(Controller):path="/users"@post()asyncdefcreate_user(self,data:User)->User: ...@get()asyncdeflist_users(self)->List[User]: ...@get(path="/{date:int}")asyncdeflist_new_users(self,date:datetime)->List[User]: ...@patch(path="/{user_id:uuid}",dto=PartialUserDTO)asyncdefpartial_update_user(self,user_id:UUID4,data:DTOData[PartialUserDTO] )->User: ...@put(path="/{user_id:uuid}")asyncdefupdate_user(self,user_id:UUID4,data:User)->User: ...@get(path="/{user_name:str}")asyncdefget_user_by_name(self,user_name:str)->Optional[User]: ...@get(path="/{user_id:uuid}")asyncdefget_user(self,user_id:UUID4)->User: ...@delete(path="/{user_id:uuid}")asyncdefdelete_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 routehandler, 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 otherfeatures.
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 routehandlers.
Litestar also supports the programmatic creation of DTOs with aDTOFactory class, which also supports the use ofplugins.
Litestar has custom logic to generate OpenAPI 3.1.0 schema, include optional generation of examples using thepolyfactory 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 - atdifferent levels of the application, and then selective use or overwrite them.
Example for DI
fromlitestarimportLitestar,getfromlitestar.diimportProvideasyncdefmy_dependency()->str: ...@get("/")asyncdefindex(injected:str)->str:returninjectedapp=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 calledguards, which allows the user to define guard functions at differentlevel of the application (app, router, controller etc.) and validate the request before hitting the route handlerfunction.
Example for route guards
fromlitestarimportLitestar,getfromlitestar.connectionimportASGIConnectionfromlitestar.handlers.baseimportBaseRouteHandlerfromlitestar.exceptionsimportNotAuthorizedExceptionasyncdefis_authorized(connection:ASGIConnection,handler:BaseRouteHandler)->None:# validate authorization# if not authorized, raise NotAuthorizedExceptionraiseNotAuthorizedException()@get("/",guards=[is_authorized])asyncdefindex()->None: ...app=Litestar([index])
Litestar supports request life cycle hooks, similarly to Flask - i.e.before_request andafter_request
Litestar is fast. It is on par with, or significantly faster than comparable ASGI frameworks.
You can see and run the benchmarkshere,or read more about ithere in our documentation.
Litestar is open to contributions big and small. You can alwaysjoin our discord serverorjoin our Matrix spaceto discuss contributions and project maintenance. For guidelines on how to contribute, pleaseseethe contribution guide.
Thanks goes to these wonderful people:
Emoji KeyThis project follows theall-contributors specification.Contributions of any kind welcome!
About
Light, flexible and extensible ASGI framework | Built to scale
Topics
Resources
License
Code of conduct
Contributing
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
