starlette README

The project's README from github.com/Kludex/starlette. As one markdown file: README.md.

starlette-logo

✨ The little ASGI framework that shines. ✨


Build Status Package version Supported Python Version Discord


Documentation: https://starlette.dev

Source Code: https://github.com/Kludex/starlette


Starlette

Starlette is a lightweight ASGI framework/toolkit, which is ideal for building async web services in Python.

It is production-ready, and gives you the following:

Installation

$ pip install starlette

You'll also want to install an ASGI server, such as uvicorn or any of the other ASGI server implementations.

$ pip install uvicorn

Example

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route


async def homepage(request):
    return JSONResponse({'hello': 'world'})

routes = [
    Route("/", endpoint=homepage)
]

app = Starlette(debug=True, routes=routes)

Then run the application using Uvicorn:

$ uvicorn main:app

Dependencies

Starlette only requires anyio, and the following are optional:

You can install all of these with pip install starlette[full].

Framework or Toolkit

Starlette is designed to be used either as a complete framework, or as an ASGI toolkit. You can use any of its components independently.

from starlette.responses import PlainTextResponse


async def app(scope, receive, send):
    assert scope['type'] == 'http'
    response = PlainTextResponse('Hello, world!')
    await response(scope, receive, send)

Run the app application in example.py:

$ uvicorn example:app
INFO: Started server process [11509]
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Run uvicorn with --reload to enable auto-reloading on code changes.

Modularity

The modularity that Starlette is designed on promotes building reusable components that can be shared between any ASGI framework. This should enable an ecosystem of shared middleware and mountable applications.

The clean API separation also means it's easier to understand each component in isolation.


Starlette is BSD licensed code.
Designed & crafted with care.

— ⭐️ —

starlette (Kludex/starlette)

Searching Database…

12.7K ·GitHub
Что это?Starlette — это лёгкий ASGI-фреймворк и набор инструментов для создания асинхронных веб-сервисов на Python: небольшой, готовый к продакшену и с минимумом обязательных зависимостей.
Это полноценный фреймворк или набор инструментов, из которого можно брать отдельные части?И то, и другое. Его можно использовать как законченный фреймворк или как ASGI-набор инструментов, причём любой из его компонентов работает и сам по себе.
Как запустить простейшее приложение?Установите Starlette через pip, запустите приложение через ASGI-сервер, например uvicorn (например, uvicorn example:app), а при разработке добавьте флаг --reload, чтобы приложение автоматически перезапускалось при изменении кода.
Что он подтягивает за собой?Обязательна только anyio; httpx, jinja2, python-multipart, itsdangerous, pyyaml и opentelemetry-api — необязательные дополнения. Всё вместе ставится командой pip install starlette[full].
Он действительно готов к продакшену или это минималистичная игрушка?Он готов к продакшену: 100% покрытие тестами, полностью аннотированный типами код, мало обязательных зависимостей и отличная общая производительность в независимых бенчмарках.
Что есть из коробки?Поддержка WebSocket, фоновые задачи внутри процесса, события запуска и остановки, тестовый клиент, CORS, GZip, раздача статических файлов, потоковые ответы, а также поддержка сессий и cookies.
Он работает с asyncio или можно использовать trio?И то, и другое — Starlette совместим с бэкендами asyncio и trio, так что можно оставить ту асинхронную связку, которой вы уже пользуетесь.
Насколько он быстрый?В README говорится об отличной общей производительности по независимым бенчмаркам, что соответствует его лёгкой архитектуре с минимумом зависимостей.
Можно ли использовать его middleware и компоненты с другими ASGI-фреймворками?Да — его модульность поощряет переиспользуемые компоненты, общие для любого ASGI-фреймворка, а чёткое разделение API позволяет легко разобраться в каждой части отдельно.
What are similar projects?aiohttp, axum, actix-web, uvicorn, koa, ktor, echo, sanic
Creator
Kludex
Size
8.5 MB
Stars
12.7K
Age
8y
Commits · 90 Days