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

Uploaded Source

Built Distribution

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

sanic-24.12.0-py3-none-any.whl (245.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sanic-24.12.0.tar.gz
  • Upload date:
  • Size: 351.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for sanic-24.12.0.tar.gz
Algorithm Hash digest
SHA256 09c23aa917616c1e60e44c66dfd7582cb9fd6503f78298c309945909f5839836
MD5 8f9561ab86b2e15b9d1200e4e38e5c1f
BLAKE2b-256 5cd68761c9df89392c4330c123f1ecc85cfb3884522f3a58e86a7b1809b2d608

See more details on using hashes here.

Provenance

The following attestation bundles were made for sanic-24.12.0.tar.gz:

Publisher: publish-release.yml on sanic-org/sanic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: sanic-24.12.0-py3-none-any.whl
  • Upload date:
  • Size: 245.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for sanic-24.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2a01ec0b6c5926e3efe34eac1b497d31ed989038fe213eb25ad0c98687d388
MD5 38c775c6dcee2d4b3456278b2889c45c
BLAKE2b-256 f0f382f38246e8af7976f59f7913a00c8e84325ddb58e05312ab530ce381fdbf

See more details on using hashes here.

Provenance

The following attestation bundles were made for sanic-24.12.0-py3-none-any.whl:

Publisher: publish-release.yml on sanic-org/sanic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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