About sanic

Sanic is a Python 3.10+ web server and web framework designed for speed. It leverages the async/await syntax to enable non-blocking, high-performance code. Sanic is ASGI compliant, allowing deployment with alternative ASGI webservers. It uses uvloop and ujson by default for enhanced performance, with options to disable these. Installation is straightforward via pip. The framework aims to provide a simple way to build, expand, and scale highly performant HTTP servers. The project is community-maintained and welcomes contributions. Sanic is suitable for developers building fast, scalable web applications and APIs in Python.

s

Published by

sanic-org

Visit View Profile

README.md

View on GitHub

.. image:: https://raw.githubusercontent.com/sanic-org/sanic-assets/master/png/sanic-framework-logo-400x97.png :alt: Sanic | Build fast. Run fast.

Sanic | Build fast. Run fast.

.. start-badges

.. list-table:: :widths: 15 85 :stub-columns: 1

* - Build
  - | |Tests|
* - Docs
  - | |UserGuide| |Documentation|
* - Package
  - | |PyPI| |PyPI version| |Wheel| |Supported implementations| |Code style ruff|
* - Support
  - | |Forums| |Discord| |Awesome|
* - Stats
  - | |Monthly Downloads| |Weekly Downloads| |Conda downloads|

.. end-badges

Sanic is a Python 3.10+ 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 <https://sanicframework.org/en/guide/deployment/running.html#asgi>_.

Source code on GitHub <https://github.com/sanic-org/sanic/> | Help and discussion board <https://community.sanicframework.org/> | User Guide <https://sanicframework.org> | Chat on Discord <https://discord.gg/FARQzAEMAA>

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.

Sponsor

Check out open collective <https://opencollective.com/sanic-org>_ to learn more about helping to fund Sanic.

Installation

pip 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.

.. code:: shell

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

.. note::

If you are running on a clean install of Fedora 28 or above, please make sure you have the redhat-rpm-config package installed in case if you want to use sanic with ujson dependency.

Hello World Example

.. code:: python

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'})

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

.. code::

[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

.. code::

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.10.

Documentation

User Guide, Changelog, and API Documentation can be found at sanic.dev <https://sanic.dev>__.

Questions and Discussion

Ask a question or join the conversation <https://community.sanicframework.org/>__.

Contribution

We are always happy to have new contributions. We have marked issues good for anyone looking to get started <https://github.com/sanic-org/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>, and welcome questions on the forums <https://community.sanicframework.org/>. Please take a look at our Contribution guidelines <https://github.com/sanic-org/sanic/blob/master/CONTRIBUTING.md>_.

sanic