From 8e8d9426df25536ce4b6aa6f18c7b45821f2ca73 Mon Sep 17 00:00:00 2001 From: Axel Haustant Date: Thu, 16 Apr 2015 14:26:19 +0200 Subject: [PATCH] Document about tox testing --- CONTRIBUTING.rst | 2 ++ README.rst | 17 ++++++++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8754896a..0ad7fd5c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -46,6 +46,8 @@ General Guidelines - Write tests and make sure they pass (make sure you have a mongod running on the default port, then execute ``python setup.py test`` from the cmd line to run the test suite). +- Ensure tests pass on every Python and PyMongo versions. + You can test on these versions locally by executing ``tox`` - Add yourself to AUTHORS :) Documentation diff --git a/README.rst b/README.rst index 1d01d8b7..59fbe194 100644 --- a/README.rst +++ b/README.rst @@ -8,10 +8,10 @@ MongoEngine .. image:: https://secure.travis-ci.org/MongoEngine/mongoengine.png?branch=master :target: http://travis-ci.org/MongoEngine/mongoengine - -.. image:: https://coveralls.io/repos/MongoEngine/mongoengine/badge.png?branch=master + +.. image:: https://coveralls.io/repos/MongoEngine/mongoengine/badge.png?branch=master :target: https://coveralls.io/r/MongoEngine/mongoengine?branch=master - + .. image:: https://landscape.io/github/MongoEngine/mongoengine/master/landscape.png :target: https://landscape.io/github/MongoEngine/mongoengine/master :alt: Code Health @@ -98,6 +98,17 @@ Tests To run the test suite, ensure you are running a local instance of MongoDB on the standard port, and run: ``python setup.py test``. +To run the test suite on every supported Python version and every supported PyMongo version, +you can use ``tox``. +tox and each supported Python version should be installed in your environment: + +.. code-block:: shell + + # Install tox + $ pip install tox + # Run the test suites + $ tox + Community ========= - `MongoEngine Users mailing list