skip to navigation
skip to content

couchbasekit 0.2.2

A wrapper around CouchBase Python driver for document validation and more.

couchbasekit is a wrapper around CouchBase Python driver for document validation and more. It was inspired by MongoKit and was developed by the project coming soon?, which is also an open source project.

You can get detailed information about couchbase itself from and about its Python driver form


Source code:

Quick Start

Less talk, more code. Set your authentication details first:

from couchbasekit import Connection

# you should do this somewhere beginning such as
Connection.auth('myusername', 'p@ssword')

Then define your model document.

import datetime
from couchbasekit import Document, register_view
from couchbasekit.fields import EmailField, ChoiceField
from example.samples.publisher import Publisher
from import Book

class Gender(ChoiceField):
    CHOICES = {
        'M': 'Male',
        'F': 'Female',

class Author(Document):
    __bucket_name__ = 'couchbasekit_samples'
    __key_field__ = 'slug' # optional
    doc_type = 'author'
    structure = {
        'slug': unicode,
        'first_name': unicode,
        'last_name': unicode,
        'gender': Gender,
        'email': EmailField,
        'publisher': Publisher, # kind of foreign key
        'books': [Book], # 1-to-many
        'has_book': bool,
        'age': int,
        'created_at': datetime.datetime,
    default_values = { # optional
        'has_book': False,
        # don't worry about the timezone info!
        # it's auto assigned as to UTC, so all you have to do is:
        'created_at': datetime.datetime.utcnow,
    required_fields = ( # optional

Then use it as such;

>>> from import Author, Gender
>>> from couchbasekit.fields import EmailField
>>> douglas = Author()
>>> douglas.is_new_record
>>> try:
...     douglas.validate()
... except Author.StructureError as why:
...     print why
Key field 'slug' is defined but not provided.
>>> douglas.slug = u'douglas_adams'
>>> try:
...     douglas.validate()
... except Author.StructureError as why:
...     print why
Required field for 'first_name' is missing.
>>> isinstance(douglas, dict)
>>> douglas.update({
...     'first_name': u'Douglas',
...     'last_name': u'Adams',
...     'gender': Gender('M'),
...     'email': EmailField(''),
... })
>>> douglas.validate()
>>> douglas.cas_value # CAS value (version) of the couchbase document
>>> douglas.doc_id
>>> douglas.birthday is None
>>> douglas.non_exist_field
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "couchbasekit/", line 68, in __getattr__
    return super(Document, self).__getattribute__(item)
AttributeError: 'Author' object has no attribute 'non_exist_field'
>>> dna = Author('douglas_adams')
>>> dna.is_new_record
>>> douglas==dna
>>> douglas.has_book = True
>>> douglas==dna
>>> # because we set @register_view decorator, here are the CouchBase views:
>>> douglas.view()
<couchbase.client.DesignDoc at 0x10d3ebe10>
>>> view = douglas.view('by_fullname')
>>> view
<couchbase.client.View at 0x10ce57410>
>>> view.results({'key': 'Douglas Adams'})
<couchbase.client.ViewResultsIterator at 0x10d40dad0>
>>> # please refer to CouchBase views documentation for further usage..
>>> # and the bucket itself for advanced folks:
>>> douglas.bucket
<couchbase.client.Bucket at 0x10fb0c2d0>
>>> print [m for m in dir(douglas.bucket) if not m.startswith('_')]
['add', 'append', 'cas', 'decr', 'delete', 'design_docs', 'flush', 'gat', 'get', 'getl', 'incr', 'info', 'mc_client', 'name', 'password', 'prepend', 'replace', 'save', 'server', 'set', 'stats', 'touch', 'view']
>>> # nice!
File Type Py Version Uploaded on Size
couchbasekit-0.2.2.tar.gz (md5) Source 2013-04-18 15KB
  • Downloads (All Versions):
  • 2 downloads in the last day
  • 71 downloads in the last week
  • 405 downloads in the last month