From 5ec9d1019b667b82a12a723f7008374479bf8ef2 Mon Sep 17 00:00:00 2001 From: Ross Lawley Date: Thu, 22 Dec 2011 16:10:29 +0000 Subject: [PATCH] Documentation updates --- doc/index.rst | 2 + doc/tools.rst | 135 ++++++++++++++++++-------------------------------- 2 files changed, 51 insertions(+), 86 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 19352b972..b34fca847 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_. About This Documentation ------------------------ diff --git a/doc/tools.rst b/doc/tools.rst index f32b42a72..4424d57f6 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -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 `_ framework - is an ORM-like layer on top of PyMongo. There is also a MongoKit - `google group `_. - -Ming - `Ming `_ (the Merciless) is a - library that allows you to enforce schemas on a MongoDB database in - your Python application. It was developed by `SourceForge - `_ in the course of their migration to - MongoDB. See the `introductory blog post - `_ - for more details. - -MongoAlchemy - `MongoAlchemy `_ is another ORM-like layer on top of - PyMongo. Its API is inspired by `SQLAlchemy `_. The - code is available `on github `_; - for more information, see `the tutorial `_. - -MongoEngine - `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 - `_; for more information, see - the `tutorial `_. - -django-mongodb-engine - `Django MongoDB Engine - `_ is a MongoDB - database backend for Django that completely integrates with its ORM. - For more information `see the tutorial `_. - -Minimongo - `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 - `_. - -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 `_ (11/2009) - - `mongodb-object `_ (10/2009) - - `MongoMagic `_ (7/2009) - - `django-mongodb `_ (7/2009) +* `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 `_. +* `Ming `_ (the Merciless) was developed by + `SourceForge `_ in the course of their migration to + MongoDB. + For more information, see + `the tutorial `_. +* `MongoAlchemy `_ is inspired by the popular + `SQLAlchemy `_ database toolkit. + For more information, see `the tutorial `_. +* `MongoEngine `_ allows you to define schemas + for documents and query collections using syntax inspired by the Django + ORM.For more information, see `the tutorial + `_. +* `minimongo `_ is a lightweight, + schemaless, Pythonic Object-Oriented interface to MongoDB. For more + information see `the 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 `_ provides MongoDB - backends for Django sessions and authentication (bypassing - :mod:`django.db` entirely). - -mongodb_beaker - `mongodb_beaker `_ is a +* `Django MongoDB Engine + `_ is a MongoDB database backend for Django that + completely integrates with its ORM. For more information + `see the tutorial `_. +* `mango `_ provides MongoDB backends for + Django sessions and authentication (bypassing :mod:`django.db` entirely). +* `mongodb_beaker `_ is a project to enable using MongoDB as a backend for `beaker's `_ caching / session system. - `The source is on github - `_. - -MongoLog - `MongoLog `_ - is a Python logging handler that stores logs in MongoDB using a - capped collection. - -c5t - `c5t `_ is a - content-management system using TurboGears and MongoDB. - -rod.recipe.mongodb - `rod.recipe.mongodb - `_ is a ZC Buildout - recipe for downloading and installing MongoDB. - -repoze-what-plugins-mongodb - `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 `_. +* `MongoLog `_ is a Python logging + handler that stores logs in MongoDB using a capped collection. +* `c5t `_ is a content-management system + using TurboGears and MongoDB. +* `rod.recipe.mongodb `_ is a + ZC Buildout recipe for downloading and installing MongoDB. +* `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 `_ is - an asynchronous Python driver for MongoDB, although it is not - currently recommended for production use. +* `asyncmongo `_ is an asynchronous library + for accessing mongo which is built on the tornado ioloop. +* `TxMongo `_ is an + asynchronous Python driver for MongoDB, although it is not currently + recommended for production use.