Document about tox testing
This commit is contained in:
parent
57f301815d
commit
8e8d9426df
@ -46,6 +46,8 @@ General Guidelines
|
|||||||
- Write tests and make sure they pass (make sure you have a mongod
|
- Write tests and make sure they pass (make sure you have a mongod
|
||||||
running on the default port, then execute ``python setup.py test``
|
running on the default port, then execute ``python setup.py test``
|
||||||
from the cmd line to run the test suite).
|
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 :)
|
- Add yourself to AUTHORS :)
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
|
17
README.rst
17
README.rst
@ -8,10 +8,10 @@ MongoEngine
|
|||||||
|
|
||||||
.. image:: https://secure.travis-ci.org/MongoEngine/mongoengine.png?branch=master
|
.. image:: https://secure.travis-ci.org/MongoEngine/mongoengine.png?branch=master
|
||||||
:target: http://travis-ci.org/MongoEngine/mongoengine
|
: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
|
:target: https://coveralls.io/r/MongoEngine/mongoengine?branch=master
|
||||||
|
|
||||||
.. image:: https://landscape.io/github/MongoEngine/mongoengine/master/landscape.png
|
.. image:: https://landscape.io/github/MongoEngine/mongoengine/master/landscape.png
|
||||||
:target: https://landscape.io/github/MongoEngine/mongoengine/master
|
:target: https://landscape.io/github/MongoEngine/mongoengine/master
|
||||||
:alt: Code Health
|
:alt: Code Health
|
||||||
@ -98,6 +98,17 @@ Tests
|
|||||||
To run the test suite, ensure you are running a local instance of MongoDB on
|
To run the test suite, ensure you are running a local instance of MongoDB on
|
||||||
the standard port, and run: ``python setup.py test``.
|
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
|
Community
|
||||||
=========
|
=========
|
||||||
- `MongoEngine Users mailing list
|
- `MongoEngine Users mailing list
|
||||||
|
Loading…
x
Reference in New Issue
Block a user