Light-weight and flexible ASGI API Framework
Project description
Starlite
Starlite is a light, opinionated and flexible ASGI API framework built on top of pydantic and Starlette.
Check out the Starlite documentation 📚
Core Features
- 👉 OpenAPI 3.1 schema generation
- 👉 built-in Redoc based OpenAPI UI
- 👉 class based controllers
- 👉 decorators based configuration
- 👉 extended testing support
- 👉 extensive typing support including inference, validation and parsing
- 👉 full async (ASGI) support
- 👉 layered dependency injection
- 👉 route guards based authorization
- 👉 simple middleware and authentication
- 👉 support for pydantic models and pydantic dataclasses
- 👉 support for standard library dataclasses
- 👉 ultra-fast json serialization and deserialization using orjson
Installation
Using your package manager of choice:
pip install starlite
OR
poetry add starlite
OR
pipenv install starlite
Minimal Example
Define your data model using pydantic or any library based on it (see for example ormar, beanie, SQLModel etc.):
from pydantic import BaseModel, UUID4
class User(BaseModel):
first_name: str
last_name: str
id: UUID4
You can alternatively use a dataclass, either the standard library one or the one from pydantic:
from uuid import UUID
# from pydantic.dataclasses import dataclass
from dataclasses import dataclass
@dataclass
class User:
first_name: str
last_name: str
id: UUID
Define a Controller for your data model:
from pydantic import UUID4
from starlite.controller import Controller
from starlite.handlers import get, post, put, patch, delete
from starlite.types import Partial
from my_app.models import User
class UserController(Controller):
path = "/users"
@post()
async def create(self, data: User) -> User:
...
@get()
async def get_users(self) -> 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: list[User]) -> list[User]:
...
@get(path="/{user_id:uuid}")
async def get_user_by_id(self, user_id: UUID4) -> User:
...
@delete(path="/{user_id:uuid}")
async def delete_user_by_id(self, user_id: UUID4) -> User:
...
Import your controller into your application's entry-point and pass it to Starlite when instantiating your app:
from starlite import Starlite
from my_app.controllers.user import UserController
app = Starlite(route_handlers=[UserController])
To run you application, use an ASGI server such as uvicorn:
uvicorn my_app.main:app --reload
Contributing
Starlite is open to contributions big and small. You can always join our discord server to discuss contributions and project maintenance. For guidelines on how to contribute, please see the contribution guide.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.