Commit 5b462f49 authored by Denis Bilenko's avatar Denis Bilenko

add README.rst

parent b0bef39e
gevent
======
gevent is a coroutine_-based Python_ networking library that uses greenlet_ to provide
a high-level synchronous API on top of libevent_ event loop.
Features include:
* convenient API around greenlets
* familiar synchronization primitives (gevent.event, gevent.queue)
* socket module that cooperates (gevent.socket)
* WSGI server on top of libevent-http (gevent.wsgi2)
* DNS requests done through libevent-dns
* Monkey patching utility to get pure Python modules to cooperate
.. _coroutine: http://en.wikipedia.org/wiki/Coroutine
.. _Python: http://www.python.org
.. _greenlet: http://codespeak.net/py/0.9.2/greenlet.html
.. _libevent: http://monkey.org/~provos/libevent/
examples
--------
Browse ``examples/`` folder at bitbucket_ or `google code`_.
.. _bitbucket: http://bitbucket.org/denis/gevent/src/tip/examples/
.. _google code: http://code.google.com/p/gevent/source/browse/#hg/examples
documentation
-------------
Read the documentation online at http://gevent.org
get gevent
----------
The latest release (0.11.0) is available on the `Python Package Index.`_
.. _Python Package Index.: http://pypi.python.org/pypi/gevent
The current development version is available in a Mercurial repository:
* at bitbucket: http://bitbucket.org/denis/gevent/
* on google code: http://code.google.com/p/gevent/
installation
------------
Install the dependencies:
* greenlet: http://pypi.python.org/pypi/greenlet (it can be installed with ``easy_install greenlet``)
* libevent 1.4.x: http://monkey.org/~provos/libevent/
gevent runs on Python 2.4 and higher.
similar projects
----------------
* `Eventlet <http://eventlet.net/>`_
* `Concurrence <http://opensource.hyves.org/concurrence/>`_
* `StacklessSocket <http://code.google.com/p/stacklessexamples/wiki/StacklessNetworking>`_
feedback
--------
Use `Issue Tracker on Google Code`__ for the bug reports.
__ http://code.google.com/p/gevent/issues/list
Contact me directly at denis.bilenko at gmail.com.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment