Commit 005296a1 authored by Jason Madden's avatar Jason Madden

Links to the coveralls and appveyor pages.

parent 40971c18
========= ========
gevent_ gevent
========= ========
gevent_ is a coroutine-based Python networking library. gevent_ is a coroutine-based Python networking library.
...@@ -21,7 +21,7 @@ gevent`_. ...@@ -21,7 +21,7 @@ gevent`_.
gevent is licensed under MIT license. gevent is licensed under MIT license.
get gevent Get gevent
========== ==========
Install Python 2.6, 2.7, 3.3 or 3.4 along with the greenlet_ extension Install Python 2.6, 2.7, 3.3 or 3.4 along with the greenlet_ extension
...@@ -36,36 +36,58 @@ Post feedback and issues on the `bug tracker`_, `mailing list`_, blog_ ...@@ -36,36 +36,58 @@ Post feedback and issues on the `bug tracker`_, `mailing list`_, blog_
and `twitter (@gevent)`_. and `twitter (@gevent)`_.
installing from github Development
====================== ===========
To install the latest development version: To install the latest development version::
pip install cython git+git://github.com/gevent/gevent.git#egg=gevent pip install cython git+git://github.com/gevent/gevent.git#egg=gevent
running tests Running Tests
============= -------------
There are a few different ways to run the tests. To simply run the There are a few different ways to run the tests. To simply run the
tests on one version of Python during development, try this: tests on one version of Python during development, try this::
python setup.py build python setup.py build
cd greentest cd greentest
PYTHONPATH=.. python testrunner.py --config ../known_failures.py PYTHONPATH=.. python testrunner.py --config ../known_failures.py
Before submitting a pull request, it's a good idea to run the tests 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 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 using pep8 and pyflakes. This is what is done on Travis CI. Locally it
can be done using tox: can be done using tox::
pip install tox pip install tox
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
<open htmlcov/index.html>
Builds on Travis CI automatically submit updates to `coveralls.io`_.
.. image:: https://coveralls.io/repos/gevent/gevent/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/gevent/gevent?branch=master
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.
.. image:: https://travis-ci.org/gevent/gevent.svg?branch=master
:target: https://travis-ci.org/gevent/gevent
.. _gevent: http://www.gevent.org .. _gevent: http://www.gevent.org
.. _greenlet: http://pypi.python.org/pypi/greenlet .. _greenlet: http://pypi.python.org/pypi/greenlet
.. _libev: http://libev.schmorp.de/ .. _libev: http://libev.schmorp.de/
...@@ -79,3 +101,6 @@ can be done using tox: ...@@ -79,3 +101,6 @@ can be done using tox:
.. _mailing list: http://groups.google.com/group/gevent .. _mailing list: http://groups.google.com/group/gevent
.. _blog: http://blog.gevent.org .. _blog: http://blog.gevent.org
.. _twitter (@gevent): http://twitter.com/gevent .. _twitter (@gevent): http://twitter.com/gevent
.. _coverage.py: https://pypi.python.org/pypi/coverage/
.. _coveralls.io: https://coveralls.io/github/gevent/gevent
.. _AppVeyor: https://ci.appveyor.com/project/denik/gevent
...@@ -320,7 +320,11 @@ else: ...@@ -320,7 +320,11 @@ else:
# If we are running info / help commands, we don't need to build anything # If we are running info / help commands, we don't need to build anything
if len(sys.argv) >= 2 and ('--help' in sys.argv[1:] or if len(sys.argv) >= 2 and ('--help' in sys.argv[1:] or
sys.argv[1] in ('--help-commands', 'egg_info', '--version', 'clean')): sys.argv[1] in ('--help-commands',
'egg_info',
'--version',
'clean',
'--long-description')):
ext_modules = [] ext_modules = []
include_package_data = PYPY include_package_data = PYPY
run_make = False run_make = False
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment