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-24.6.0.tar.gz (352.0 kB view details)

Uploaded Source

Built Distribution

sanic-24.6.0-py3-none-any.whl (244.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sanic-24.6.0.tar.gz
  • Upload date:
  • Size: 352.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sanic-24.6.0.tar.gz
Algorithm Hash digest
SHA256 2e0841e2c8c28e68a0e6fc570c42aafbbe3b385d7141b9f96997d9d6c17d7afb
MD5 dbf0ebe09a610ca81342c837ac073c8d
BLAKE2b-256 3700d252369495fe3bc876fb7c269ec204800b6f66fdd9083d4dd29ee7539130

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sanic-24.6.0-py3-none-any.whl
  • Upload date:
  • Size: 244.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sanic-24.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2c6b392e213d85d9843cf27c64e3f2dacb3ec5c31c8c7ade4c404cd3030e994
MD5 b4d6a7773147aa79b6c5843f684c80f5
BLAKE2b-256 76884c61ced275fa8978775e4380c423250161470ef5b418e94685128f161102

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page