Python-PouchDB

Python-PouchDB is a Python wrapper for the PouchDB JavaScript library.

If you just want to use PouchDB like in JavaScript, check out the documentation for the pouchdb package. It’s all you need when using Python-PouchDB normally.

If you want to store Python objects (for JSON-serializable objects you don’t need this!) in your PouchDB, you have two options:

• The pouchdb.objectstorage module: Pickles Python objects using jsonpickle and stores them in PouchDB. Easy to use, but less useful when other programs need to access the same database.
• The pouchdb.mapping module: Like the couchdb.mapping module, this module provides one-on-one mapping of PouchDB documents onto Python objects. Cleaner, but more work to set up.

Python-PouchDB uses Qt to wrap PouchDB. This means you need one of its Python bindings: PySide, PyQt4 or PyQt5. When multiple are installed, it uses the one which is already imported at the time the pouchdb module is imported (or chooses one itself when none are).

Table of Contents

• The pouchdb package
• The pouchdb.objectstorage module
• The pouchdb.mapping module
• The pouchdb.tests package
• JavaScript documentation

PouchDB Plug-ins

Python-PouchDB not only wraps PouchDB, but also quite a few of its plug-ins. Their Python API is described in the documentation for the pouchdb package. The included plug-ins are as follows:

Third party plug-ins:

• GQL (documentation)
• PouchDB All DBs
• PouchDB Authentication
• PouchDB Search
• PouchDB Spatial

Plug-ins developed alongside Python-PouchDB:

• PouchDB List
• PouchDB Rewrite
• PouchDB Show
• PouchDB Update
• PouchDB Validation

JavaScript documentation for the plug-ins developed alongside Python-PouchDB is available on their JavaScript documentation page.

For more information on the plug-ins developed alongside Python-PouchDB, and download links for their browser versions, see their common webpage.