Accelerate your web app development | Build fast. Run fast.
Go to file
Richard K c8b0e7f2a7 Created methods to append and finish body content on Request (#1379)
* created methods to append and finish body content on request.py so the underlying body instance can have certain flexibility; modified server.py to reflect these changes

* - made some adjustments (including the Request.body_init method) as requested by @ahopkins;
- created a new test with a custom Request class implementation of the flexibility provided by the new methods;
2018-11-12 09:11:41 -06:00
.github/ISSUE_TEMPLATE Update issue templates 2018-10-16 15:42:52 +03:00
docker Install Python 3.5 and 3.6 on docker container 2018-01-24 16:46:45 +03:30
docs Update document for logging 2018-11-12 16:09:12 +08:00
examples Pausable response streams (#1179) 2018-08-18 18:12:13 -07:00
sanic Created methods to append and finish body content on Request (#1379) 2018-11-12 09:11:41 -06:00
tests Created methods to append and finish body content on Request (#1379) 2018-11-12 09:11:41 -06:00
.appveyor.yml fix .appveyor.yml 2018-11-10 06:11:01 -08:00
.coveragerc Fix response ci header (#1244) 2018-07-11 01:44:21 -07:00
.gitattributes Introduce end-of-line normalization 2016-10-15 12:59:00 -07:00
.gitignore fixed small doc issue (#877) 2017-08-02 10:15:18 -07:00
.travis.yml fix travisci 2018-10-13 18:19:08 -07:00
CHANGELOG.md Corrected Raphael Deem's name in changelog - sorry @r0fls! 2018-09-24 09:05:58 -05:00
CONDUCT.md Add maintainers email address 2017-05-22 15:31:05 -07:00
CONTRIBUTING.md Add Code of Conduct 2017-05-19 23:09:44 +08:00
environment.yml fix readthedoc build 2018-10-21 01:56:48 -07:00
LICENSE Fix LICENSE date and name 2017-08-30 15:30:22 +02:00
Makefile Install Python 3.5 and 3.6 on docker container 2018-01-24 16:46:45 +03:30
MANIFEST.in include LICENSE file in manifest 2017-10-17 16:05:24 +02:00
pyproject.toml run black against sanic module 2018-10-13 17:55:33 -07:00
README.rst fix unit test for windows ci 2018-11-12 01:04:53 -08:00
readthedocs.yml Adding readthedocs file 2017-01-29 16:40:36 -08:00
requirements-dev.txt pinned httptools requirement to version 0.0.10+ 2018-10-03 12:22:29 -03:00
requirements-docs.txt add sphinx extension to add asyncio-specific markups 2017-09-30 01:16:26 +08:00
requirements.txt Merge pull request #1304 from ignatenkobrain/fedora 2018-10-04 18:45:22 -05:00
setup.cfg integrate with isort 2018-10-17 21:20:16 -07:00
setup.py added black for lint check 2018-10-13 18:10:43 -07:00
tox.ini integrate with isort 2018-10-17 21:20:16 -07:00

Sanic
=====

|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |AppVeyor Build Status| |Documentation| |Codecov| |PyPI| |PyPI version| |Code style black|

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/huge-success/sanic/>`_. We also have `a community discussion board <https://community.sanicframework.org/>`_. Contributions are welcome!

If you have a project that utilizes Sanic make sure to comment on the `issue <https://github.com/huge-success/sanic/issues/396>`_ that we use to track those projects!

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)

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

-  ``pip install sanic``

To install sanic without uvloop or ujson using bash, you can provide either or both of these environmental variables
using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the NO_X to true will stop that features
installation.

- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip install sanic``


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

`Documentation on Readthedocs <http://sanic.readthedocs.io/>`_.

.. |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
.. |Codecov| image:: https://codecov.io/gh/huge-success/sanic/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/huge-success/sanic
.. |Build Status| image:: https://travis-ci.org/huge-success/sanic.svg?branch=master
   :target: https://travis-ci.org/huge-success/sanic
.. |AppVeyor Build Status| image:: https://ci.appveyor.com/api/projects/status/d8pt3ids0ynexi8c/branch/master?svg=true
   :target: https://ci.appveyor.com/project/huge-success/sanic
.. |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 black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black
   
Questions and Discussion
------------------------

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


Examples
--------
`Non-Core examples <https://github.com/huge-success/sanic/wiki/Examples/>`_. Examples of plugins and Sanic that are outside the scope of Sanic core.

`Extensions <https://github.com/huge-success/sanic/wiki/Extensions/>`_. Sanic extensions created by the community.

`Projects <https://github.com/huge-success/sanic/wiki/Projects/>`_. Sanic in production use.


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

::

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