README.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. Eventlet is a concurrent networking library for Python that allows you to change how you run your code, not how you write it.
  2. 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.
  3. It's easy to get started using Eventlet, and easy to convert existing
  4. applications to use it. Start off by looking at the `examples`_,
  5. `common design patterns`_, and the list of `basic API primitives`_.
  6. .. _examples: http://eventlet.net/doc/examples.html
  7. .. _common design patterns: http://eventlet.net/doc/design_patterns.html
  8. .. _basic API primitives: http://eventlet.net/doc/basic_usage.html
  9. Quick Example
  10. ===============
  11. Here's something you can try right on the command line::
  12. % python
  13. >>> import eventlet
  14. >>> from eventlet.green import urllib2
  15. >>> gt = eventlet.spawn(urllib2.urlopen, 'http://eventlet.net')
  16. >>> gt2 = eventlet.spawn(urllib2.urlopen, 'http://secondlife.com')
  17. >>> gt2.wait()
  18. >>> gt.wait()
  19. Getting Eventlet
  20. ==================
  21. The easiest way to get Eventlet is to use pip::
  22. pip install -U eventlet
  23. To install latest development version once::
  24. pip install -U https://github.com/eventlet/eventlet/archive/master.zip
  25. Building the Docs Locally
  26. =========================
  27. 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`)::
  28. cd doc
  29. make html
  30. The built html files can be found in doc/_build/html afterward.
  31. Twisted
  32. =======
  33. Eventlet had Twisted hub in the past, but community interest to this integration has dropped over time,
  34. now it is not supported, so with apologies for any inconvenience we discontinue Twisted integration.
  35. If you have a project that uses Eventlet with Twisted, your options are:
  36. * use last working release eventlet==0.14
  37. * 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.
  38. * fork Eventlet, revert Twisted removal, identify and fix problems. This work may be merged back into main project.
  39. Apologies for any inconvenience.
  40. Flair
  41. =====
  42. .. image:: https://travis-ci.org/eventlet/eventlet.svg?branch=master
  43. :target: https://travis-ci.org/eventlet/eventlet
  44. .. image:: https://codecov.io/gh/eventlet/eventlet/branch/master/graph/badge.svg
  45. :target: https://codecov.io/gh/eventlet/eventlet