gevent 1.1rc4

Coroutine-based network library

gevent is a coroutine-based Python networking library.

Features include:

• Fast event loop based on libev.

• Lightweight execution units based on greenlet.

• Familiar API that re-uses concepts from the Python standard library.

• Cooperative sockets with SSL support.

• DNS queries performed through c-ares or a threadpool.

• Ability to use standard library and 3rd party modules written for standard blocking sockets

gevent is inspired by eventlet but features more consistent API, simpler implementation and better performance. Read why others use gevent and check out the list of the open source projects based on gevent.

gevent is licensed under MIT license.

Get gevent

Gevent runs on Python >= 2.6, Python >= 3.3, or PyPy >= 4.0.1 (but not PyPy3) (Note: PyPy is not supported in Windows). On all platforms, installing setuptools is recommended (this is done automatically if working in a virtual environment).

While gevent v1.1 is not yet released, it has release candidates which are currently considered quite stable, with many bugfixes over v1.0. v1.1 is also necessary if you are running OS X 10.11 and/or Python 3 or PyPy. To install one of these release candidates, you can run:

pip install --pre gevent

Download the latest release from Python Package Index or clone the repository.

Read the documentation online at http://www.gevent.org

Post feedback and issues on the bug tracker, mailing list, blog and twitter (@gevent).

Development

To install the latest development version:

pip install setuptools 'cython>=0.23.4' git+git://github.com/gevent/gevent.git#egg=gevent

To hack on gevent (using a virtualenv):

$ git clone https://github.com/gevent/gevent.git
$ cd gevent
$ virtualenv env
$ source env/bin/activate
(env) $ pip install -r dev-requirements.txt

Note

You must have Cython, a C compiler, and the Python development headers installed to build a checkout. Installing CFFI on CPython (it’s standard on PyPy) allows building the CFFI backend for testing, and tox is the command used to test multiple versions of Python.

Running Tests

There are a few different ways to run the tests. To simply run the tests on one version of Python during development, try this:

python setup.py develop
cd greentest
PYTHONPATH=.. python testrunner.py --config ../known_failures.py

Before submitting a pull request, it’s a good idea to run the tests across all supported versions of Python, and to check the code quality using pep8 and pyflakes. This is what is done on Travis CI. Locally it can be done using tox:

pip install tox
tox

The testrunner accepts a --coverage argument to enable code coverage metrics through the coverage.py package. That would go something like this:

cd greentest
PYTHONPATH=.. python testrunner.py --config ../known_failures.py --coverage
coverage combine
coverage html -i
<open htmlcov/index.html>

Builds on Travis CI automatically submit updates to coveralls.io.

Continuous integration

A test suite is run for every push and pull request submitted. Travis CI is used to test on Linux, and AppVeyor runs the builds on Windows.