RETIRED, further work has moved to Debian project infrastructure
Go to file
Sergey Shepelev de6d5e3b7a v0.20.1 release 2017-01-03 04:11:45 +03:00
benchmarks Reformat with autopep8 2014-10-11 01:41:30 +01:00
bin v0.20.1 release 2017-01-03 04:11:45 +03:00
doc v0.20.1 release 2017-01-03 04:11:45 +03:00
eventlet v0.20.1 release 2017-01-03 04:11:45 +03:00
examples websocket: update example for Blob 2016-11-05 18:54:54 +03:00
tests test_import_patched_defaults bended to play with pyopenssl>=16.1.0 2016-12-31 20:50:04 +03:00
.gitignore doc: gitignore; ./build-website.bash --no-commit 2014-09-28 15:39:15 +04:00
.hgignore Add an initial basic tox configuration file 2012-08-07 00:46:58 +01:00
.travis.yml bundle dnspython in support/; resolving is always green 2016-08-24 11:51:28 +05:00
AUTHORS v0.20.1 release 2017-01-03 04:11:45 +03:00
LICENSE Updated LICENSE dates. 2010-02-20 15:07:31 -05:00
MANIFEST.in hubs: drop Twisted support 2014-10-29 11:21:05 +03:00
NEWS v0.20.1 release 2017-01-03 04:11:45 +03:00
README.rst readme: latest dev version was pointing to bitbucket 2016-12-12 01:58:51 +03:00
setup.cfg release: use twine for PyPI upload 2016-12-12 01:48:39 +03:00
setup.py Explicit environ flag for importing eventlet.__version__ without ignoring import errors 2016-12-12 01:48:39 +03:00
tox.ini test_import_patched_defaults bended to play with pyopenssl>=16.1.0 2016-12-31 20:50:04 +03:00

README.rst

Eventlet is a concurrent networking library for Python that allows you to change how you run your code, not how you write it.

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.

It's easy to get started using Eventlet, and easy to convert existing applications to use it. Start off by looking at the examples, common design patterns, and the list of basic API primitives.

Quick Example

Here's something you can try right on the command line:

% python
>>> import eventlet
>>> from eventlet.green import urllib2
>>> gt = eventlet.spawn(urllib2.urlopen, 'http://eventlet.net')
>>> gt2 = eventlet.spawn(urllib2.urlopen, 'http://secondlife.com')
>>> gt2.wait()
>>> gt.wait()

Getting Eventlet

The easiest way to get Eventlet is to use pip:

pip install -U eventlet

To install latest development verson once:

pip install -U https://github.com/eventlet/eventlet/archive/master.zip

Building the Docs Locally

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):

cd doc
make html

The built html files can be found in doc/_build/html afterward.

Twisted

Eventlet had Twisted hub in the past, but community interest to this integration has dropped over time, now it is not supported, so with apologies for any inconvenience we discontinue Twisted integration.

If you have a project that uses Eventlet with Twisted, your options are:

  • use last working release eventlet==0.14
  • start a new project with only Twisted hub code, identify and fix problems. As of eventlet 0.13, EVENTLET_HUB environment variable can point to external modules.
  • fork Eventlet, revert Twisted removal, identify and fix problems. This work may be merged back into main project.

Apologies for any inconvenience.