The little ASGI library that shines.
Project description
✨ The little ASGI framework that shines. ✨
Documentation: https://www.starlette.io/
Starlette
Starlette is a lightweight ASGI framework/toolkit, which is ideal for building high performance async services.
It is production-ready, and gives you the following:
- Seriously impressive performance.
- WebSocket support.
- In-process background tasks.
- Startup and shutdown events.
- Test client built on
requests. - CORS, GZip, Static Files, Streaming responses.
- Session and Cookie support.
- 100% test coverage.
- 100% type annotated codebase.
- Few hard dependencies.
- Compatible with
asyncioandtriobackends.
Requirements
Python 3.6+
Installation
$ pip3 install starlette
You'll also want to install an ASGI server, such as uvicorn, daphne, or hypercorn.
$ pip3 install uvicorn
Example
example.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:
$ uvicorn example:app
For a more complete example, see encode/starlette-example.
Dependencies
Starlette only requires anyio, and the following are optional:
requests- Required if you want to use theTestClient.jinja2- Required if you want to useJinja2Templates.python-multipart- Required if you want to support form parsing, withrequest.form().itsdangerous- Required forSessionMiddlewaresupport.pyyaml- Required forSchemaGeneratorsupport.
You can install all of these with pip3 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.
Performance
Independent TechEmpower benchmarks show Starlette applications running under Uvicorn as one of the fastest Python frameworks available. (*)
For high throughput loads you should:
- Run using gunicorn using the
uvicornworker class. - Use one or two workers per-CPU core. (You might need to experiment with this.)
- Disable access logging.
Eg.
gunicorn -w 4 -k uvicorn.workers.UvicornWorker --log-level warning example:app
Several of the ASGI servers also have pure Python implementations available,
so you can also run under PyPy if your application code has parts that are
CPU constrained.
Either programatically:
uvicorn.run(..., http='h11', loop='asyncio')
Or using Gunicorn:
gunicorn -k uvicorn.workers.UvicornH11Worker ...
— ⭐️ —
Starlette is BSD licensed code. Designed & built in Brighton, England.
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
Built Distribution
File details
Details for the file starlette-0.17.1.tar.gz.
File metadata
- Download URL: starlette-0.17.1.tar.gz
- Upload date:
- Size: 48.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 57eab3cc975a28af62f6faec94d355a410634940f10b30d68d31cb5ec1b44ae8 |
|
| MD5 | a9960dc0aea67530e2a99ab43c147933 |
|
| BLAKE2b-256 | 11d3c346849b8201f0e0339e23850c8db1cebd477e44e8b5212f40e1acbb490c |
File details
Details for the file starlette-0.17.1-py3-none-any.whl.
File metadata
- Download URL: starlette-0.17.1-py3-none-any.whl
- Upload date:
- Size: 58.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 26a18cbda5e6b651c964c12c88b36d9898481cd428ed6e063f5f29c418f73050 |
|
| MD5 | 26c966dbe35004798a4dac6ac2281709 |
|
| BLAKE2b-256 | 3257e9c68acc2845ee4ca66202d19856f6a3581cab2a885d25d490103270ffa2 |
