Skip to main content

The little ASGI library that shines.

Project description

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:

  • A lightweight, low-complexity HTTP web framework.
  • WebSocket support.
  • In-process background tasks.
  • Startup and shutdown events.
  • Test client built on httpx.
  • CORS, GZip, Static Files, Streaming responses.
  • Session and Cookie support.
  • 100% test coverage.
  • 100% type annotated codebase.
  • Few hard dependencies.
  • Compatible with asyncio and trio backends.
  • Great overall performance against independent benchmarks.

Installation

$ pip install starlette

You'll also want to install an ASGI server, such as uvicorn, daphne, or hypercorn.

$ 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:

  • httpx - Required if you want to use the TestClient.
  • jinja2 - Required if you want to use Jinja2Templates.
  • python-multipart - Required if you want to support form parsing, with request.form().
  • itsdangerous - Required for SessionMiddleware support.
  • pyyaml - Required for SchemaGenerator support.

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 re-usable 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.

— ⭐️ —

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.

Source Distribution

starlette-0.52.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

starlette-0.52.0-py3-none-any.whl (74.2 kB view details)

Uploaded Python 3

File details

Details for the file starlette-0.52.0.tar.gz.

File metadata

  • Download URL: starlette-0.52.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starlette-0.52.0.tar.gz
Algorithm Hash digest
SHA256 04f1ceafbda34cd571512b799650554d4f0dc638f09128e44ea521f32486f170
MD5 1c774be2d629045fc9cb318b327ff66b
BLAKE2b-256 5137b1006d61b07385ca826b2f6a1d37d4708b8870326b5f9a2426f3a76bb5ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for starlette-0.52.0.tar.gz:

Publisher: publish.yml on Kludex/starlette

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file starlette-0.52.0-py3-none-any.whl.

File metadata

  • Download URL: starlette-0.52.0-py3-none-any.whl
  • Upload date:
  • Size: 74.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starlette-0.52.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae047dccdfedb2dd9f86efe182e259eb72bcf50e7cd49309a46c906160df2545
MD5 dceb84aaa5f25931883917a706247439
BLAKE2b-256 6ccdb6aa3477a731e89f9a52dcb08afda8d21fcdd9ab6b62bba2a4d956b8f914

See more details on using hashes here.

Provenance

The following attestation bundles were made for starlette-0.52.0-py3-none-any.whl:

Publisher: publish.yml on Kludex/starlette

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page