Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/channelcat/sanic

Accelerate your web app development | Build fast. Run fast.
https://github.com/channelcat/sanic

api-server asgi asyncio framework python sanic web web-framework web-server

Last synced: about 1 month ago
JSON representation

Accelerate your web app development | Build fast. Run fast.

Awesome Lists containing this project

README 

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



.. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068

   :target: https://sanic.dev/

.. |Forums| image:: https://img.shields.io/badge/forums-community-ff0068.svg

   :target: https://community.sanicframework.org/

.. |Discord| image:: https://img.shields.io/discord/812221182594121728?logo=discord&label=Discord&color=5865F2

   :target: https://discord.gg/FARQzAEMAA

.. |Tests| image:: https://github.com/sanic-org/sanic/actions/workflows/tests.yml/badge.svg?branch=main

   :target: https://github.com/sanic-org/sanic/actions/workflows/tests.yml

.. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest

   :target: http://sanic.readthedocs.io/en/latest/?badge=latest

.. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg

   :target: https://pypi.python.org/pypi/sanic/

.. |PyPI version| image:: https://img.shields.io/pypi/pyversions/sanic.svg

   :target: https://pypi.python.org/pypi/sanic/

.. |Code style ruff| image:: https://img.shields.io/badge/code%20style-ruff-000000.svg

    :target: https://docs.astral.sh/ruff/

.. |Wheel| image:: https://img.shields.io/pypi/wheel/sanic.svg

    :alt: PyPI Wheel

    :target: https://pypi.python.org/pypi/sanic

.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/sanic.svg

    :alt: Supported implementations

    :target: https://pypi.python.org/pypi/sanic

.. |Awesome| image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg

    :alt: Awesome Sanic List

    :target: https://github.com/mekicha/awesome-sanic

.. |Monthly Downloads| image:: https://img.shields.io/pypi/dm/sanic.svg

    :alt: Downloads

    :target: https://pepy.tech/project/sanic

.. |Weekly Downloads| image:: https://img.shields.io/pypi/dw/sanic.svg

    :alt: Downloads

    :target: https://pepy.tech/project/sanic

.. |Conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/sanic.svg

    :alt: Downloads

    :target: https://anaconda.org/conda-forge/sanic



.. end-badges



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.



Sponsor

-------



Check out `open collective `_ to learn more about helping to fund Sanic.



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.



    .. code:: shell



       $ export SANIC_NO_UVLOOP=true

       $ export SANIC_NO_UJSON=true

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



    if __name__ == '__main__':

        app.run()



Sanic can now be easily run 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.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 `_.