Documentation updates

This commit is contained in:
Ross Lawley 2011-12-22 16:10:29 +00:00 committed by behackett
parent 466fb99350
commit 5ec9d1019b
2 changed files with 51 additions and 86 deletions

View File

@ -51,6 +51,8 @@ pull request.
Changes
-------
See the :doc:`changelog` for a full list of changes to PyMongo.
For older versions of the documentation please see the
`archive list <http://api.mongodb.org/python/>`_.
About This Documentation
------------------------

View File

@ -7,9 +7,10 @@ list it here.
.. note:: We try to keep this list current. As such, projects that
have not been updated recently or appear to be unmaintained will
occasionally be removed from the list or moved to the back (to keep
the list from becoming too intimidating). If a project gets removed
that is still being developed or is in active use please let us
know or add it back.
the list from becoming too intimidating).
If a project gets removed that is still being developed or is in active use
please let us know or add it back.
ORM-like Layers
---------------
@ -25,97 +26,59 @@ needs. Even if you eventually come to the decision to use one of these
layers, the time spent working directly with the driver will have
increased your understanding of how MongoDB actually works.
MongoKit
The `MongoKit <http://github.com/namlook/mongokit>`_ framework
is an ORM-like layer on top of PyMongo. There is also a MongoKit
`google group <http://groups.google.com/group/mongokit>`_.
Ming
`Ming <http://merciless.sourceforge.net/>`_ (the Merciless) is a
library that allows you to enforce schemas on a MongoDB database in
your Python application. It was developed by `SourceForge
<http://sourceforge.net/>`_ in the course of their migration to
MongoDB. See the `introductory blog post
<http://blog.pythonisito.com/2009/12/ming-01-released-python-library-for.html>`_
for more details.
MongoAlchemy
`MongoAlchemy <http://mongoalchemy.org>`_ is another ORM-like layer on top of
PyMongo. Its API is inspired by `SQLAlchemy <http://sqlalchemy.org>`_. The
code is available `on github <http://github.com/jeffjenkins/MongoAlchemy>`_;
for more information, see `the tutorial <http://mongoalchemy.org/tutorial.html>`_.
MongoEngine
`MongoEngine <http://hmarr.com/mongoengine/>`_ is another ORM-like
layer on top of PyMongo. It allows you to define schemas for
documents and query collections using syntax inspired by the Django
ORM. The code is available on `github
<http://github.com/hmarr/mongoengine>`_; for more information, see
the `tutorial <http://hmarr.com/mongoengine/tutorial.html>`_.
django-mongodb-engine
`Django MongoDB Engine
<http://django-mongodb.org/>`_ is a MongoDB
database backend for Django that completely integrates with its ORM.
For more information `see the tutorial <http://django-mongodb.org/tutorial.html>`_.
Minimongo
`minimongo <http://pypi.python.org/pypi/minimongo>`_ is a lightweight,
pythonic interface to MongoDB. It retains pymongo's query and update API,
and provides a number of additional features, including a simple
document-oriented interface, connection pooling, index management, and
collection & database naming helpers. The `source is on github
<http://github.com/slacy/minimongo>`_.
Smaller or less well-maintained projects (in order from most to least
recently committed to at the time of the last update to this list):
- `pymongo-bongo <http://pypi.python.org/pypi/pymongo-bongo/>`_ (11/2009)
- `mongodb-object <http://github.com/marcboeker/mongodb-object>`_ (10/2009)
- `MongoMagic <http://bitbucket.org/bottiger/mongomagic/wiki/Home>`_ (7/2009)
- `django-mongodb <http://bitbucket.org/kpot/django-mongodb/>`_ (7/2009)
* `MongoKit <http://namlook.github.com/mongokit/>`_ is a python module that
brings structured schema and validation layer on top of the great pymongo
driver.
For more information, see
`the tutorial <http://namlook.github.com/mongokit/tutorial.html>`_.
* `Ming <http://merciless.sourceforge.net/>`_ (the Merciless) was developed by
`SourceForge <http://sourceforge.net/>`_ in the course of their migration to
MongoDB.
For more information, see
`the tutorial <http://merciless.sourceforge.net/orm.html>`_.
* `MongoAlchemy <http://mongoalchemy.org>`_ is inspired by the popular
`SQLAlchemy <http://sqlalchemy.org>`_ database toolkit.
For more information, see `the tutorial <http://mongoalchemy.org/tutorial.html>`_.
* `MongoEngine <http://mongoengine.org/>`_ allows you to define schemas
for documents and query collections using syntax inspired by the Django
ORM.For more information, see `the tutorial
<http://mongoengine.org/docs/v0.5/tutorial.html>`_.
* `minimongo <http://pypi.python.org/pypi/minimongo>`_ is a lightweight,
schemaless, Pythonic Object-Oriented interface to MongoDB. For more
information see `the example <http://pypi.python.org/pypi/minimongo#example>`_.
Framework Tools
---------------
This section lists tools and adapters that have been designed to work with various Python frameworks and libraries.
This section lists tools and adapters that have been designed to work with
various Python frameworks and libraries.
mango
`mango <http://github.com/vpulim/mango>`_ provides MongoDB
backends for Django sessions and authentication (bypassing
:mod:`django.db` entirely).
mongodb_beaker
`mongodb_beaker <http://pypi.python.org/pypi/mongodb_beaker>`_ is a
* `Django MongoDB Engine
<http://django-mongodb.org/>`_ is a MongoDB database backend for Django that
completely integrates with its ORM. For more information
`see the tutorial <http://django-mongodb.org/tutorial.html>`_.
* `mango <http://github.com/vpulim/mango>`_ provides MongoDB backends for
Django sessions and authentication (bypassing :mod:`django.db` entirely).
* `mongodb_beaker <http://pypi.python.org/pypi/mongodb_beaker>`_ is a
project to enable using MongoDB as a backend for `beaker's
<http://beaker.groovie.org/>`_ caching / session system.
`The source is on github
<http://github.com/bwmcadams/mongodb_beaker>`_.
MongoLog
`MongoLog <http://github.com/andreisavu/mongodb-log/>`_
is a Python logging handler that stores logs in MongoDB using a
capped collection.
c5t
`c5t <http://bitbucket.org/percious/c5t/>`_ is a
content-management system using TurboGears and MongoDB.
rod.recipe.mongodb
`rod.recipe.mongodb
<http://pypi.python.org/pypi/rod.recipe.mongodb/>`_ is a ZC Buildout
recipe for downloading and installing MongoDB.
repoze-what-plugins-mongodb
`repoze-what-plugins-mongodb
<http://code.google.com/p/repoze-what-plugins-mongodb/>`_ is a
project working to support a plugin for using MongoDB as a backend
for :mod:`repoze.what`.
`The source is on github <http://github.com/bwmcadams/mongodb_beaker>`_.
* `MongoLog <http://github.com/andreisavu/mongodb-log/>`_ is a Python logging
handler that stores logs in MongoDB using a capped collection.
* `c5t <http://bitbucket.org/percious/c5t/>`_ is a content-management system
using TurboGears and MongoDB.
* `rod.recipe.mongodb <http://pypi.python.org/pypi/rod.recipe.mongodb/>`_ is a
ZC Buildout recipe for downloading and installing MongoDB.
* `repoze-what-plugins-mongodb
<http://code.google.com/p/repoze-what-plugins-mongodb/>`_ is a project
working to support a plugin for using MongoDB as a backend for
:mod:`repoze.what`.
Alternative Drivers
-------------------
These are alternatives to PyMongo.
PyMonga
`PyMonga <http://github.com/fiorix/mongo-async-python-driver>`_ is
an asynchronous Python driver for MongoDB, although it is not
currently recommended for production use.
* `asyncmongo <https://github.com/bitly/asyncmongo>`_ is an asynchronous library
for accessing mongo which is built on the tornado ioloop.
* `TxMongo <http://github.com/fiorix/mongo-async-python-driver>`_ is an
asynchronous Python driver for MongoDB, although it is not currently
recommended for production use.