README.rst

Trombi README

Trombi is an asynchronous CouchDB client for Tornado.

trombi is Finnish for a small tornado, occuring in Europe.

Requirements

• Python 2.6+
• Tornado 1.0+

For running tests:

• couchdb-python
• nose

Documentation

Documentation created using Sphinx is available in doc/ directory. Compiling documentation requires version 0.6.x of Sphinx.

Online documentation can be seen on Github pages.

Issues are reported in Github and there's also a mailing list available in Google Groups.

Example program

import trombi
from tornado.ioloop import IOLoop

def main():
    server = trombi.Server('http://localhost:5984')
    server.get('my_database', database_created, create=True)

def database_created(db):
    if db.error:
        print 'Unable to create database!'
        print db.msg
        ioloop.stop()
    else:
        db.set('my_document', {'testvalue': 'something'}, doc_created)

def doc_created(doc):
    if doc.error:
        print 'Unable to create document!'
        print doc.msg
    else:
        print 'Doc added!'

    ioloop.stop()

if __name__ == '__main__':
    ioloop = IOLoop.instance()
    ioloop.add_callback(main)
    ioloop.start()

More usage examples can be found in tests.

Authors

Possibly incomplete list of authors can be found in AUTHORS file.

License

Trombi is licensed under MIT License. See LICENSE for more information.