Skip to main content

Standalone CouchDB Application Development Made Simple.

Project description

CouchApp is designed to structure standalone CouchDB application development for maximum application portability.

CouchApp is a set of scripts and a jQuery plugin designed to bring clarity and order to the freedom of CouchDB’s document-based approach.

Also, be sure to checkout our Erlang-based sibling, erica.

Write apps using just JavaScript and HTML

Render HTML documents using JavaScript templates run by CouchDB. You’ll get parallelism and cacheability, using only HTML and JS. Building standalone CouchDB applications according to correct principles affords you options not found on other platforms.

Deploy your apps to the client

CouchDB’s replication means that programs running locally can still be social. Applications control replication data-flows, so publishing messages and subscribing to other people is easy. Your users will see the benefits of the web without the hassle of requiring always-on connectivity.


Couchapp requires Python 2.6 or greater. Couchapp is most easily installed using the latest versions of the standard python packaging tools, setuptools and pip. They may be installed like so:

$ curl -O
$ sudo python

Installing couchapp is then simply a matter of:

$ pip install couchapp

On OSX 10.6/10.7 you may need to set ARCH_FLAGS:

$ env ARCHFLAGS="-arch i386 -arch x86_64" pip install couchapp

To install/upgrade a development version of couchapp:

$ pip install -e git+

Note: Some installations need to use sudo command before each command line.

Note: On debian system don’t forget to install python-dev.

To install on Windows follow instructions here.

More installation options on the website.


We use nose. and nose-testconfig. for setting up and running tests.

$ python nosetests


Our nosetests will run with options listed in setup.cfg.

In the tests directory, copy config.sample.ini to config.ini, tweak the settings, and then modify your setup.cfg:



If you’re wanting to examine code coverage reports (because you’ve got big plans to make our tests better!), you can browse around the cover dir

$ cd cover
$ python2 -m SimpleHTTPServer

or (if you prefer python3):

$ python3 -m http.server


If you want to debug the failed run with pdb, add the following option to setup.cfg:


Thanks for testing couchapp!

Building the docs

We generate the document via sphinx.

First, prepare our building env. We need sphinx:

$ cd docs/
$ pip install sphinx

To build it, just issue:

$ make html

And sphinx will generate static html at docs/_build/html. We can browse the site from this dir already.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Couchapp-1.0.2.tar.gz (80.4 kB view hashes)

Uploaded source

Built Distribution

Couchapp-1.0.2-py2-none-any.whl (98.6 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page