nicer readme note about dependencies
This commit is contained in:
parent
e5acbcc0dd
commit
4eedf00025
18
README.rst
18
README.rst
@ -35,16 +35,20 @@ setup.py install``.
|
|||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
============
|
============
|
||||||
- pymongo>=2.7.1
|
All of the dependencies can easily be installed via `pip <https://pip.pypa.io/>`_.
|
||||||
- sphinx (optional - for documentation generation)
|
|
||||||
|
|
||||||
Optional Dependencies
|
Bare minimum you need to use this package:
|
||||||
---------------------
|
- pymongo>=2.7.1
|
||||||
- **Image Fields**: Pillow>=2.0.0
|
- six>=1.10.0
|
||||||
|
|
||||||
|
If you utilize a ``DateTimeField`` and want to use a more flexible date parser:
|
||||||
- dateutil>=2.1.0
|
- dateutil>=2.1.0
|
||||||
|
|
||||||
.. note
|
If you to utilize an ``ImageField`` or ``ImageGridFsProxy``:
|
||||||
MongoEngine always runs it's test suite against the latest patch version of each dependecy. e.g.: PyMongo 3.0.1
|
- Pillow>=2.0.0
|
||||||
|
|
||||||
|
If you want to generate the documentation (e.g. to contribute to it):
|
||||||
|
- sphinx
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
========
|
========
|
||||||
|
Loading…
x
Reference in New Issue
Block a user