X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=eventlet%2FREADME.rst;fp=eventlet%2FREADME.rst;h=0000000000000000000000000000000000000000;hb=358bd9258c2b6d2ee74de4dfd07a5123107abad4;hp=ce554ed620d15815197461e7ddf1fe618e5df13d;hpb=376ff3bfe7071cc0793184a378c4e74508fb0d97;p=packages%2Ftrusty%2Fpython-eventlet.git diff --git a/eventlet/README.rst b/eventlet/README.rst deleted file mode 100644 index ce554ed..0000000 --- a/eventlet/README.rst +++ /dev/null @@ -1,64 +0,0 @@ -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`_. - -.. _examples: http://eventlet.net/doc/examples.html -.. _common design patterns: http://eventlet.net/doc/design_patterns.html -.. _basic API primitives: http://eventlet.net/doc/basic_usage.html - - -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 eventlet - -The development `tip`_ is available as well:: - - pip install 'eventlet==dev' - -.. _tip: http://bitbucket.org/eventlet/eventlet/get/tip.zip#egg=eventlet-dev - - -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.