diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 22 |
1 files changed, 8 insertions, 14 deletions
@@ -4,7 +4,7 @@ MongoEngine :Info: MongoEngine is an ORM-like layer on top of PyMongo. :Repository: https://github.com/MongoEngine/mongoengine :Author: Harry Marr (http://github.com/hmarr) -:Maintainer: Stefan Wójcik (http://github.com/wojcikstefan) +:Maintainer: Bastien Gerard (http://github.com/bagerard) .. image:: https://travis-ci.org/MongoEngine/mongoengine.svg?branch=master :target: https://travis-ci.org/MongoEngine/mongoengine @@ -21,6 +21,10 @@ MongoEngine .. image:: https://img.shields.io/pypi/v/mongoengine.svg :target: https://pypi.python.org/pypi/mongoengine + +.. image:: https://readthedocs.org/projects/mongoengine-odm/badge/?version=latest + :target: https://readthedocs.org/projects/mongoengine-odm/builds/ + About ===== MongoEngine is a Python Object-Document Mapper for working with MongoDB. @@ -44,7 +48,7 @@ You may also have `setuptools <http://peak.telecommunity.com/DevCenter/setuptool and thus you can use ``easy_install -U mongoengine``. Another option is `pipenv <https://docs.pipenv.org/>`_. You can then use ``pipenv install mongoengine`` to both create the virtual environment and install the package. Otherwise, you can -download the source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and +download the source from `GitHub <https://github.com/MongoEngine/mongoengine>`_ and run ``python setup.py install``. The support for Python2 was dropped with MongoEngine 0.20.0 @@ -62,7 +66,7 @@ If you utilize a ``DateTimeField``, you might also use a more flexible date pars If you need to use an ``ImageField`` or ``ImageGridFsProxy``: -- Pillow>=2.0.0 +- Pillow>=7.0.0 If you need to use signals: @@ -125,8 +129,7 @@ Some simple examples of what MongoEngine code looks like: Tests ===== To run the test suite, ensure you are running a local instance of MongoDB on -the standard port and have ``pytest`` installed. Then, run ``python setup.py test`` -or simply ``pytest``. +the standard port and have ``pytest`` installed. Then, run ``pytest tests/``. To run the test suite on every supported Python and PyMongo version, you can use ``tox``. You'll need to make sure you have each supported Python version @@ -139,15 +142,6 @@ installed in your environment and then: # Run the test suites $ tox -If you wish to run a subset of tests, use the pytest convention: - -.. code-block:: shell - - # Run all the tests in a particular test file - $ pytest tests/fields/test_fields.py - # Run only particular test class in that file - $ pytest tests/fields/test_fields.py::TestField - Community ========= - `MongoEngine Users mailing list |