1 Eventlet is a concurrent networking library for Python that allows you to change how you run your code, not how you write it.
3 It uses epoll or libevent for highly scalable non-blocking I/O. Coroutines ensure that the developer uses a blocking style of programming that is similar to threading, but provide the benefits of non-blocking I/O. The event dispatch is implicit, which means you can easily use Eventlet from the Python interpreter, or as a small part of a larger application.
5 It's easy to get started using Eventlet, and easy to convert existing
6 applications to use it. Start off by looking at the `examples`_,
7 `common design patterns`_, and the list of `basic API primitives`_.
9 .. _examples: http://eventlet.net/doc/examples.html
10 .. _common design patterns: http://eventlet.net/doc/design_patterns.html
11 .. _basic API primitives: http://eventlet.net/doc/basic_usage.html
17 Here's something you can try right on the command line::
21 >>> from eventlet.green import urllib2
22 >>> gt = eventlet.spawn(urllib2.urlopen, 'http://eventlet.net')
23 >>> gt2 = eventlet.spawn(urllib2.urlopen, 'http://secondlife.com')
31 The easiest way to get Eventlet is to use pip::
35 The development `tip`_ is available as well::
37 pip install 'eventlet==dev'
39 .. _tip: http://bitbucket.org/eventlet/eventlet/get/tip.zip#egg=eventlet-dev
42 Building the Docs Locally
43 =========================
45 To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/ (or installed with `pip install Sphinx`)::
50 The built html files can be found in doc/_build/html afterward.