Accelerate your web app development | Build fast. Run fast.
Go to file
Kyle Blöm cedf1d0b00 Added new tests, new request logic, and handler file
Added new tests for alternate uses for alternate range request types.

Changed error handlnig for new request logic that simplifies the integration logic

Moved the error handler and the content range handler to their own handler file to prevent circular imports.
2017-01-30 09:13:43 -08:00
docs Update blueprints docs with correct listener example 2017-01-25 23:01:57 +11:00
examples Caching example (#334) 2017-01-23 10:19:42 -06:00
sanic Added new tests, new request logic, and handler file 2017-01-30 09:13:43 -08:00
tests Added new tests, new request logic, and handler file 2017-01-30 09:13:43 -08:00
.coveragerc add tox for test and coverage automation. Add development requirements.txt 2016-10-15 11:56:34 +02:00
.gitattributes Introduce end-of-line normalization 2016-10-15 12:59:00 -07:00
.gitignore Merge branch 'master' into sphinx-docs 2017-01-19 08:48:54 +11:00
.travis.yml Update to make flake8 actually work 2016-12-25 19:05:11 -08:00
CHANGELOG.md Reverse static arguments 2016-10-25 02:45:28 -07:00
LICENSE Added tests and middleware, and improved documentation 2016-10-14 03:23:48 -07:00
README.rst Merge branch 'master' into sphinx-docs 2017-01-20 09:30:42 +11:00
requirements-dev.txt Merge branch 'master' into sphinx-docs 2017-01-19 08:48:54 +11:00
requirements.txt Trimmed down features of CIMultiDict 2017-01-16 16:12:42 -08:00
setup.py Remove multidict requirement 2017-01-20 18:12:54 -05:00
tox.ini add beautifulsoup4 to tox 2017-01-12 20:03:35 -05:00

Sanic
=================================

|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |PyPI| |PyPI version|

Sanic is a Flask-like Python 3.5+ web server that's written to go fast.  It's based on the work done by the amazing folks at magicstack, and was inspired by `this article <https://magic.io/blog/uvloop-blazing-fast-python-networking/>`_.

On top of being Flask-like, Sanic supports async request handlers.  This means you can use the new shiny async/await syntax from Python 3.5, making your code non-blocking and speedy.

Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!

Benchmarks
----------

All tests were run on an AWS medium instance running ubuntu, using 1
process. Each script delivered a small JSON response and was tested with
wrk using 100 connections. Pypy was tested for Falcon and Flask but did
not speed up requests.

+-----------+-----------------------+----------------+---------------+
| Server    | Implementation        | Requests/sec   | Avg Latency   |
+===========+=======================+================+===============+
| Sanic     | Python 3.5 + uvloop   | 33,342         | 2.96ms        |
+-----------+-----------------------+----------------+---------------+
| Wheezy    | gunicorn + meinheld   | 20,244         | 4.94ms        |
+-----------+-----------------------+----------------+---------------+
| Falcon    | gunicorn + meinheld   | 18,972         | 5.27ms        |
+-----------+-----------------------+----------------+---------------+
| Bottle    | gunicorn + meinheld   | 13,596         | 7.36ms        |
+-----------+-----------------------+----------------+---------------+
| Flask     | gunicorn + meinheld   | 4,988          | 20.08ms       |
+-----------+-----------------------+----------------+---------------+
| Kyoukai   | Python 3.5 + uvloop   | 3,889          | 27.44ms       |
+-----------+-----------------------+----------------+---------------+
| Aiohttp   | Python 3.5 + uvloop   | 2,979          | 33.42ms       |
+-----------+-----------------------+----------------+---------------+
| Tornado   | Python 3.5            | 2,138          | 46.66ms       |
+-----------+-----------------------+----------------+---------------+

Hello World Example
-------------------

.. code:: python

    from sanic import Sanic
    from sanic.response import json


    app = Sanic()


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

    if __name__ == "__main__":
        app.run(host="0.0.0.0", port=8000)

SSL Example
-----------

Optionally pass in an SSLContext:

.. code:: python

  import ssl
  certificate = "/path/to/certificate"
  keyfile = "/path/to/keyfile"
  context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH)
  context.load_cert_chain(certificate, keyfile=keyfile)

  app.run(host="0.0.0.0", port=8443, ssl=context)

Installation
------------

-  ``python -m pip install sanic``

Documentation
-------------

Documentation can be found in the ``docs`` directory.

.. |Join the chat at https://gitter.im/sanic-python/Lobby| image:: https://badges.gitter.im/sanic-python/Lobby.svg
   :target: https://gitter.im/sanic-python/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Build Status| image:: https://travis-ci.org/channelcat/sanic.svg?branch=master
   :target: https://travis-ci.org/channelcat/sanic
.. |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/

TODO
----
* Streamed file processing
* File output
* Examples of integrations with 3rd-party modules
* RESTful router

Limitations
-----------
* No wheels for uvloop and httptools on Windows :(

Final Thoughts
--------------

::

                     ▄▄▄▄▄
            ▀▀▀██████▄▄▄       _______________
          ▄▄▄▄▄  █████████▄  /                 \
         ▀▀▀▀█████▌ ▀▐▄ ▀▐█ |   Gotta go fast!  |
       ▀▀█████▄▄ ▀██████▄██ | _________________/
       ▀▄▄▄▄▄  ▀▀█▄▀█════█▀ |/
            ▀▀▀▄  ▀▀███ ▀       ▄▄
         ▄███▀▀██▄████████▄ ▄▀▀▀▀▀▀█▌
       ██▀▄▄▄██▀▄███▀ ▀▀████      ▄██
    ▄▀▀▀▄██▄▀▀▌████▒▒▒▒▒▒███     ▌▄▄▀
    ▌    ▐▀████▐███▒▒▒▒▒▐██▌
    ▀▄▄▄▄▀   ▀▀████▒▒▒▒▄██▀
              ▀▀█████████▀
            ▄▄██▀██████▀█
          ▄██▀     ▀▀▀  █
         ▄█             ▐▌
     ▄▄▄▄█▌              ▀█▄▄▄▄▀▀▄
    ▌     ▐                ▀▀▄▄▄▀
     ▀▀▄▄▀