README 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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 easy_install or pip::
  22. easy_install eventlet
  23. pip install eventlet
  24. The development `tip`_ is available via easy_install as well::
  25. easy_install 'eventlet==dev'
  26. pip install 'eventlet==dev'
  27. .. _tip: http://bitbucket.org/which_linden/eventlet/get/tip.zip#egg=eventlet-dev
  28. Building the Docs Locally
  29. =========================
  30. To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/ (or installed with `easy_install sphinx`)
  31. cd doc
  32. make html
  33. The built html files can be found in doc/_build/html afterward.