The lightning-fast ASGI server.
Project description
The lightning-fast ASGI server.
Documentation: https://www.uvicorn.org
Community: https://discuss.encode.io/c/uvicorn
Requirements: Python 3.6+ (For Python 3.5 support, install version 0.8.6.)
Uvicorn is a lightning-fast ASGI server implementation, using uvloop and httptools.
Until recently Python has lacked a minimal low-level server/application interface for asyncio frameworks. The ASGI specification fills this gap, and means we're now able to start building a common set of tooling usable across all asyncio frameworks.
Uvicorn currently supports HTTP/1.1 and WebSockets. Support for HTTP/2 is planned.
Quickstart
Install using pip:
$ pip install uvicorn
This will install uvicorn with minimal (pure Python) dependencies.
$ pip install uvicorn[standard]
This will install uvicorn with "Cython-based" dependencies (where possible) and other "optional extras".
In this context, "Cython-based" means the following:
- the event loop
uvloopwill be installed and used if possible. - the http protocol will be handled by
httptoolsif possible.
Moreover, "optional extras" means that:
- the websocket protocol will be handled by
websockets(should you want to usewsprotoyou'd need to install it manually) if possible. - the
--reloaderflag in development mode will usewatchgod. - windows users will have
coloramainstalled for the colored logs. python-dotenvwill be installed should you want to use the--env-fileoption.PyYAMLwill be installed to allow you to provide a.yamlfile to--log-config, if desired.
Create an application, in example.py:
async def app(scope, receive, send):
assert scope['type'] == 'http'
await send({
'type': 'http.response.start',
'status': 200,
'headers': [
[b'content-type', b'text/plain'],
],
})
await send({
'type': 'http.response.body',
'body': b'Hello, world!',
})
Run the server:
$ uvicorn example:app
Uvicorn 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 uvicorn-0.12.3.tar.gz.
File metadata
- Download URL: uvicorn-0.12.3.tar.gz
- Upload date:
- Size: 32.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5836edaf4d278fe67ba0298c0537bdb6398cf359eb644f79e6500ca1aad232b3 |
|
| MD5 | 94c414b3c7155004c81a7d71d701cb83 |
|
| BLAKE2b-256 | 89e875ea123f733aefac57d43b37cb81f24f16e5d71d3f9cf7cf25c0f5a9a274 |
File details
Details for the file uvicorn-0.12.3-py3-none-any.whl.
File metadata
- Download URL: uvicorn-0.12.3-py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 562ef6aaa8fa723ab6b82cf9e67a774088179d0ec57cb17e447b15d58b603bcf |
|
| MD5 | d5205ec3c70ccb114dddd7dbddc2fe44 |
|
| BLAKE2b-256 | 09577089ac75bc304bd1b237c6cb271ff0cbad621f40f44a7e5bdb56f0ab5290 |
