Repository: Kludex/starlette

Stars: 12213

README.md Copy Chapter

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Kludex/starlette/main/docs/img/starlette_dark.svg" width="420px">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Kludex/starlette/main/docs/img/starlette.svg" width="420px">
<img alt="starlette-logo" src="https://raw.githubusercontent.com/Kludex/starlette/main/docs/img/starlette.svg">
</picture>
</p>

<p align="center">
<em>✨ The little ASGI framework that shines. ✨</em>
</p>

---


---

Documentation: <a href="https://starlette.dev/" target="_blank">https://starlette.dev</a>

Source Code: <a href="https://github.com/Kludex/starlette" target="_blank">https://github.com/Kludex/starlette</a>

---

Starlette

Starlette is a lightweight [ASGI][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][techempower].

Installation Copy Chapter

$ pip install starlette

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

$ pip install uvicorn

Example Copy Chapter

``python title="main.py"
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:

Dependencies  Copy Chapter
Starlette only requires anyio, and the following are optional:
* [httpx][httpx] - Required if you want to use the TestClient.
* [jinja2][jinja2] - Required if you want to use Jinja2Templates.
* [python-multipart][python-multipart] - Required if you want to support form parsing, with request.form().
* [itsdangerous][itsdangerous] - Required for SessionMiddleware support.
* [pyyaml][pyyaml] - Required for SchemaGenerator support.
You can install all of these with pip install starlette[full].
Framework or Toolkit  Copy Chapter
Starlette is designed to be used either as a complete framework, or as
an ASGI toolkit. You can use any of its components independently.

Run the app application in example.py:

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

Modularity Copy Chapter

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.

---

<p align="center"><i>Starlette is <a href="https://github.com/Kludex/starlette/blob/main/LICENSE.md">BSD licensed</a> code.<br/>Designed & crafted with care.</i></br>&mdash; ⭐️ &mdash;</p>

[asgi]: https://asgi.readthedocs.io/en/latest/
[httpx]: https://www.python-httpx.org/
[jinja2]: https://jinja.palletsprojects.com/
[python-multipart]: https://multipart.fastapiexpert.com/
[itsdangerous]: https://itsdangerous.palletsprojects.com/
[sqlalchemy]: https://www.sqlalchemy.org
[pyyaml]: https://pyyaml.org/wiki/PyYAMLDocumentation
[techempower]: https://www.techempower.com/benchmarks/#hw=ph&test=fortune&l=zijzen-sf