Skip to main content

A web server and web framework that's written to go fast. Build fast. Run fast.

Project description

Sanic | Build fast. Run fast.

Sanic | Build fast. Run fast.

Build

Tests

Docs

UserGuide Documentation

Package

PyPI PyPI version PyPI Wheel Supported implementations Code style ruff

Support

Forums Discord Awesome Sanic List

Stats

Downloads Downloads Downloads

Sanic is a Python 3.8+ web server and web framework that’s written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy.

Sanic is also ASGI compliant, so you can deploy it with an alternative ASGI webserver.

Source code on GitHub | Help and discussion board | User Guide | Chat on Discord

The project is maintained by the community, for the community. Contributions are welcome!

The goal of the project is to provide a simple way to get up and running a highly performant HTTP server that is easy to build, to expand, and ultimately to scale.

Installation

pip3 install sanic

Sanic makes use of uvloop and ujson to help with performance. If you do not want to use those packages, simply add an environmental variable SANIC_NO_UVLOOP=true or SANIC_NO_UJSON=true at install time.

$ export SANIC_NO_UVLOOP=true
$ export SANIC_NO_UJSON=true
$ pip3 install --no-binary :all: sanic

Hello World Example

from sanic import Sanic
from sanic.response import json

app = Sanic("my-hello-world-app")

@app.route('/')
async def test(request):
    return json({'hello': 'world'})

if __name__ == '__main__':
    app.run()

Sanic can now be easily run using sanic hello.app.

[2018-12-30 11:37:41 +0200] [13564] [INFO] Goin' Fast @ http://127.0.0.1:8000
[2018-12-30 11:37:41 +0200] [13564] [INFO] Starting worker [13564]

And, we can verify it is working: curl localhost:8000 -i

HTTP/1.1 200 OK
Connection: keep-alive
Keep-Alive: 5
Content-Length: 17
Content-Type: application/json

{"hello":"world"}

Now, let’s go build something fast!

Minimum Python version is 3.8. If you need Python 3.7 support, please use v22.12LTS.

Documentation

User Guide, Changelog, and API Documentation can be found at sanic.dev.

Questions and Discussion

Ask a question or join the conversation.

Contribution

We are always happy to have new contributions. We have marked issues good for anyone looking to get started, and welcome questions on the forums. Please take a look at our Contribution guidelines.

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

sanic-23.12.0.tar.gz (344.4 kB view details)

Uploaded Source

Built Distribution

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

sanic-23.12.0-py3-none-any.whl (236.1 kB view details)

Uploaded Python 3

File details

Details for the file sanic-23.12.0.tar.gz.

File metadata

  • Download URL: sanic-23.12.0.tar.gz
  • Upload date:
  • Size: 344.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for sanic-23.12.0.tar.gz
Algorithm Hash digest
SHA256 de829a85b02d7ceea3795e5ba3552cd6cb656321654b5bbd7789bb9c0384a19a
MD5 bbd87ea4be6d7973dc91c2b1f9561521
BLAKE2b-256 1fac605ef5c05446ca0c9e1e62a4370f048e8d9105b2fb3ba01ac197054482e0

See more details on using hashes here.

File details

Details for the file sanic-23.12.0-py3-none-any.whl.

File metadata

  • Download URL: sanic-23.12.0-py3-none-any.whl
  • Upload date:
  • Size: 236.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for sanic-23.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33a92c66c9a533065744fc20339a13974736d2f87d505813076d344b43ae9956
MD5 34f4e8172a8078ffdf68129425df1ff5
BLAKE2b-256 ca4901434a2a88bb1acf912021db16de8d079d407e2ecb97b5c59c93334edaf6

See more details on using hashes here.

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