Code Monkey home page Code Monkey logo

starlite's Introduction

Starlite logo

PyPI - License PyPI - Python Version

Coverage

Quality Gate Status Maintainability Rating Reliability Rating Security Rating

Language grade: Python Total alerts

All Contributors

Discord Matrix

Medium

Starlite

Starlite is a powerful, flexible and highly performant ASGI API framework built on top of Starlette and pydantic.

Check out the Starlite documentation πŸ“š

Installation

pip install starlite

Core Features

  • Both functional and OOP python support
  • Class based controllers
  • Extended testing support
  • Builtin Validation and Parsing using Pydantic
  • Dataclass Support
  • Dependency Injection
  • Layered Middleware
  • Layered Parameter declaration
  • Route Guards based Authorization
  • Life Cycle Hooks
  • Plugin System
  • SQLAlchemy Support (via plugin)
  • Tortoise-ORM Support (via plugin)
  • Automatic OpenAPI 3.1 schema generation
  • Support for Redoc
  • Support for Swagger-UI
  • Support for Stoplight Elements
  • Ultra-fast json serialization and deserialization using orjson

Example Applications

  • starlite-pg-redis-docker: In addition to Starlite, this demonstrates a pattern of application modularity, SQLAlchemy 2.0 ORM, Redis cache connectivity, and more. Like all Starlite projects, this application is open to contributions, big and small.
  • starlite-hello-world: A bare-minimum application setup. Great for testing and POC work.

Relation to Starlette and FastAPI

Although Starlite uses the Starlette ASGI toolkit, it does not simply extend Starlette, as FastAPI does. Starlite uses selective pieces of Starlette while implementing its own routing and parsing logic, the primary reason for this is to enforce a set of best practices and discourage misuse. This is done to promote simplicity and scalability - Starlite is simple to use, easy to learn, and unlike both Starlette and FastAPI - it keeps complexity low when scaling.

Performant

Additionally, Starlite is very fast in comparison to other ASGI frameworks. In fact, the only framework that is faster in our benchmarks is BlackSheep, which is almost completely written in cython and does not work with pydantic out of the box as such:

JSON Benchmarks

API JSON Benchmarks

PlainText Benchmarks

API Plaintext Benchmarks

Legend:

  • a-: async, s-: sync
  • np: no params, pp: path param, qp: query param, mp: mixed params

You can see and run the benchmarks here.

Class Based Controllers

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

from typing import List, Optional, NoReturn

from pydantic import UUID4
from starlite import Controller, Partial, get, post, put, patch, delete
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) -> NoReturn:
        ...

ReDoc, Swagger-UI and Stoplight Elements API Documentation

While running Starlite, you can view the generated OpenAPI documentation using a ReDoc site, a Swagger-UI as well as a Stoplight Elements site.

Data Parsing, Type Hints and Pydantic

One key difference between Starlite and Starlette/FastAPI is in parsing of form data and query parameters- Starlite supports mixed form data and has faster and better query parameter parsing.

Starlite 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 Starlite uses typing data to generate OpenAPI specs, as well as to validate and parse data. Thus typing is absolutely essential to the framework.

Furthermore, Starlite allows extending its support using plugins.

SQLAlchemy Support, Plugin System and DTOs

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

Starlite also supports the programmatic creation of DTOs with a DTOFactory class, which also supports the use of plugins.

OpenAPI

Starlite has custom logic to generate OpenAPI 3.1.0 schema, the latest version. The schema generated by Starlite is significantly more complete and more correct than those generated by FastAPI, and they include optional generation of examples using the pydantic-factories library.

Dependency Injection

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

Middleware

Starlite supports the Starlette Middleware system while simplifying it and offering builtin configuration of CORS and some other middlewares.

Route Guards

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

Request Life Cycle Hooks

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

Contributing

Starlite 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

🚧 πŸ’» πŸ“–

Peter Schutt

🚧 πŸ’» πŸ“–

Ashwin Vinod

πŸ’» πŸ“–

Damian

πŸ“–

Vincent Sarago

πŸ’»

Jonas KrΓΌger Svensson

πŸ“¦

Sondre LillebΓΈ Gundersen

πŸ“¦

Lev

πŸ’» πŸ€”

Tim Wedde

πŸ’»

Tory Clasen

πŸ’»

Arseny Boykov

πŸ’» πŸ€”

Jacob Rodgers

πŸ’‘

Dane Solberg

πŸ’»

madlad33

πŸ’»

Matthew Aylward

πŸ’»

Jan Klima

πŸ’»

C2D

⚠️

to-ph

πŸ’»

imbev

πŸ“–

cătălin

πŸ’»

Seon82

πŸ“–

Slava

πŸ’»

Harry

πŸ’» πŸ“–

Cody Fincher

πŸ’» πŸ“– 🚧

Christian Clauss

πŸ“–

josepdaniel

πŸ’»

devtud

πŸ›

Nicholas Ramos

πŸ’»

seladb

πŸ“– πŸ’»

Simon WienhΓΆfer

πŸ’»

MobiusXS

πŸ’»

Aidan Simard

πŸ“–

wweber

πŸ’»

Samuel Colvin

πŸ’»

Mateusz MikoΕ‚ajczyk

πŸ’»

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

starlite's People

Contributors

goldziher avatar peterschutt avatar allcontributors[bot] avatar ashwinvin avatar dkress59 avatar yudjinn avatar bobronium avatar tclasen avatar vincentsarago avatar danesolberg avatar timwedde avatar vrslev avatar cofin avatar joko013 avatar sondrelg avatar seladb avatar jonasks avatar madlad33 avatar dr-emann avatar imbev avatar adriangb avatar aidan-simard avatar dependabot[bot] avatar 185504a9 avatar slavugan avatar seon82 avatar butch78 avatar harry-lees avatar cclauss avatar anze3db avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.