Ultra fast asyncio event loop.
Go to file
Yury Selivanov fc812cb43d Bump the version to 0.10.4.dev0 2018-08-07 16:34:39 -04:00
.ci Bump Cython from 0.28.2 to 0.28.3 2018-05-31 15:17:59 -04:00
.github github: Add PYTHONASYNCIODEBUG question. 2017-03-29 11:47:40 -04:00
docs Simplify venv creation procedure. (#96) 2017-11-10 12:23:05 -05:00
examples/bench examples/bench: Add SSL mode 2018-05-25 17:48:18 -04:00
tests tests: Improve test_task_context_4 2018-08-07 13:35:56 -04:00
uvloop Bump the version to 0.10.4.dev0 2018-08-07 16:34:39 -04:00
vendor Update libuv: v1.17.0 -> v1.20.3 2018-05-23 15:53:25 -04:00
.editorconfig Add .editorconfig 2016-10-22 13:27:57 -04:00
.gitignore gitignore: Ignore pytest turd 2018-05-22 18:48:12 -04:00
.gitmodules Switch libuv submodule url to https 2016-02-03 18:32:09 -05:00
.travis.yml Enable 3.7 ci 2018-08-07 13:49:40 -04:00
LICENSE-APACHE Update license files for GH 2017-09-13 16:30:55 -04:00
LICENSE-MIT Dual-license uvloop under MIT and Apache 2.0 2016-07-05 15:04:11 -04:00
MANIFEST.in Update manifest.in to include both licenses 2016-07-05 15:25:09 -04:00
Makefile Unbreak CI 2018-05-30 14:35:11 -04:00
README.rst readme: Change 3.5 to 3.5+; update build from source instructions 2018-05-30 16:50:55 -04:00
performance.png readme: Add a section about uvloop performance 2016-05-22 14:47:25 -04:00
pytest.ini pytest: Show all warnings 2017-11-24 15:58:12 -05:00
requirements.dev.txt Bump Cython from 0.28.2 to 0.28.3 2018-05-31 15:17:59 -04:00
setup.py setup.py: Use raw string for regexp 2018-06-25 12:56:00 -04:00

README.rst

.. image:: https://travis-ci.org/MagicStack/uvloop.svg?branch=master
    :target: https://travis-ci.org/MagicStack/uvloop

.. image:: https://ci.appveyor.com/api/projects/status/4apd79e5jqrwwe40/branch/master?svg=true
    :target: https://ci.appveyor.com/project/MagicStack/uvloop

.. image:: https://img.shields.io/pypi/v/uvloop.svg
    :target: https://pypi.python.org/pypi/uvloop


uvloop is a fast, drop-in replacement of the built-in asyncio
event loop.  uvloop is implemented in Cython and uses libuv
under the hood.

The project documentation can be found
`here <http://uvloop.readthedocs.org/>`_.  Please also check out the
`wiki <https://github.com/MagicStack/uvloop/wiki>`_.


Performance
-----------

uvloop makes asyncio 2-4x faster.

.. image:: performance.png
    :target: http://magic.io/blog/uvloop-blazing-fast-python-networking/

The above chart shows the performance of an echo server with different
message sizes.  The *sockets* benchmark uses ``loop.sock_recv()`` and
``loop.sock_sendall()`` methods; the *streams* benchmark uses asyncio
high-level streams, created by the ``asyncio.start_server()`` function;
and the *protocol* benchmark uses ``loop.create_server()`` with a simple
echo protocol.  Read more about uvloop
`performance <http://magic.io/blog/uvloop-blazing-fast-python-networking/>`_.


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

uvloop requires Python 3.5 or greater and is available on PyPI.
Use pip to install it::

    $ pip install uvloop


Using uvloop
------------

To make asyncio use uvloop, you can install the uvloop event
loop policy:

.. code:: python

    import asyncio
    import uvloop

    asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())


Building From Source
--------------------

To build uvloop, you'll need Python 3.5 or greater:

1. Clone the repository:

   .. code::

    $ git clone --recursive git@github.com:MagicStack/uvloop.git
    $ cd uvloop

2. Create a virtual environment and activate it, for example:

   .. code::

    $ python3.7 -m venv uvloop-dev
    $ source uvloop-dev/bin/activate

3. Install development dependencies:

   ..  code::

    $ pip install -r requirements.dev.txt

4. Build and run tests:

   .. code::

    $ make && make test


License
-------

uvloop is dual-licensed under MIT and Apache 2.0 licenses.