CouchApp: Standalone CouchDB Application Development Made Simple
CouchApp is designed to structure standalone CouchDB application development for maximum application portability.
Also, be sure to checkout our Erlang-based sibling, erica.
Table of Contents
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 https://bootstrap.pypa.io/get-pip.py $ sudo python get-pip.py
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+http://github.com/couchapp/couchapp.git#egg=Couchapp
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.
Read the tutorial.
The document of
master branch is available at
stable-1.0 is here: http://couchapp.readthedocs.io/en/stable-1.0/
$ python setup.py nosetests
nosetests will run with options listed in
tests directory, copy
the settings, and then modify your
[nosetests] ... tc-file=tests/config.ini
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
$ 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
[nosetests] ... pdb=1
Thanks for testing
We generate the document via
First, prepare our building env.
$ 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.