/usr/share/doc/python3-uvloop/README.rst is in python3-uvloop 0.8.1+ds1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | .. image:: https://travis-ci.org/MagicStack/uvloop.svg?branch=master
:target: https://travis-ci.org/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 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())
Alternatively, you can create an instance of the loop
manually, using:
.. code:: python
loop = uvloop.new_event_loop()
asyncio.set_event_loop(loop)
Development of uvloop
---------------------
To build uvloop, you'll need Cython and Python 3.5. The best way
is to create a virtual env, so that you'll have ``cython`` and
``python`` commands pointing to the correct tools.
1. ``git clone --recursive git@github.com:MagicStack/uvloop.git``
2. ``cd uvloop``
3. ``make``
4. ``make test``
License
-------
uvloop is dual-licensed under MIT and Apache 2.0 licenses.
|