The little ASGI library that shines.
Project description
✨ The little ASGI framework that shines. ✨
Documentation: https://www.starlette.io/
Starlette is a lightweight ASGI framework/toolkit.
It is ideal for building high performance asyncio services, and supports both HTTP and WebSockets.
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
from starlette.applications import Starlette
from starlette.responses import JSONResponse
import uvicorn
app = Starlette()
@app.route('/')
def homepage(request):
return JSONResponse({'hello': 'world'})
if __name__ == '__main__':
uvicorn.run(app, host='0.0.0.0', port=8001, access_log=False)
Dependencies
Starlette does not have any hard dependencies, but the following are optional:
requests- Required if you want to use theTestClient.aiofiles- Required if you want to useFileResponseorStaticFiles.ujson- Optionally used forJSONResponse.
You can install all three 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
class App:
def __init__(self, scope):
self.scope = scope
async def __call__(self, receive, send):
response = PlainTextResponse('Hello, world!')
await response(receive, send)
Run the App application in example.py:
$ uvicorn run example:App
INFO: Started server process [11509]
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
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
Our testing shows that Starlette applications running under Uvicorn as one of the fastest Python frameworks available. As an example, application performance should roughly equal or out-perform Sanic.
For high throughput loads you should:
- Make sure to install
ujson. - Run using
uvicorn, with access logging disabled.
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.
Eg. uvicorn.run(..., http='h11', loop='asyncio')
— ⭐️ —
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
File details
Details for the file starlette-0.3.0.tar.gz.
File metadata
- Download URL: starlette-0.3.0.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9824163926a95d21145343927f95965abbc9f9fe7ff7c8eff26c01e6467e2bf9 |
|
| MD5 | 13b4035099f63e834d92dad162d0765b |
|
| BLAKE2b-256 | 82e2dfe8f9052fd8ab2cad23170c02567d310d7502929ff634ae858ce1f306b6 |
