kinto-client 0.1.1

Firefox Kinto client

Kinto is a service allowing you to store and synchronize arbitrary data, attached to a user account. Its primary interface is HTTP.

kinto-client is a Python library aiming at easing interacting with a Kinto server instance. A project with related goals is also available for JavaScript.

Usage

Note

Operations are always performed directly on the server, and no synchronisation features are implemented yet.

• The first version of this API doesn’t cache any access nor provide any refresh mechanism. If you want to be sure you have the latest data available, issue another call.

Here is an overview of what the API looks like:

from kintoclient import Bucket

bucket = Bucket('default', server_url='http://localhost:8888/v1',
                auth=('alexis', 'p4ssw0rd'))
todo = bucket.get_collection('todo')

records = todo.get_records()
for i, record in enumerate(records):
    record.data.title = 'Todo #%d' %i

todo.save_records(records)

Handling buckets

All operations are rooted in a bucket. It makes little sense for one application to handle multiple buckets at once.

The passed auth parameter is a requests authentication policy, allowing authenticating using whatever fits you best.

By default, Kinto supports Firefox Accounts and Basic authentication policies.

credentials = ('alexis', 'p4ssw0rd')

bucket = Bucket('payments', server_url='http://localhost:8888/v1',
                auth=credentials)

# Passing `create=True` to the bucket will make an HTTP request to
# create it.
bucket = Bucket('payments', server_url='http://localhost:8888/v1',
                auth=credentials, create=True)

Collections

A collection is where records are stored.

# Once the bucket handy, use it to handle collections or groups.
collection = bucket.create_collection('receipts')

# Or get an existing one.
collection = bucket.get_collection('receipts')

# To delete an existing collection.
bucket.delete_collection('receipts')

Records

Records can be retrieved from and saved to collections.

# You can pass a python dictionary to create the record
record = collection.create_record(dict(id='XXX', status='done',
                                       title='Todo #1'))

# Get all records
record = collection.get_records()
record = collection.get_record(id='89881454-e4e9-4ef0-99a9-404d95900352')
collection.save_record(record)
collection.save_records([record1, record2])
collection.delete_record(id='89881454-e4e9-4ef0-99a9-404d95900352')
collection.delete_records([record1, record2])

# Alternative use
record.save()

Permissions

By default, authenticated users will get read and write access to the manipulated objects. It is possible to change this behavior by passing a dict to the permissions parameter.

record = collection.create_record(
    data={},
    permissions={'read': ['group:groupid']})

Note

Every creation or modification operation on a distant object can be given a permissions parameter.

The Bucket, Collection, Group and Record classes have a special permissions object that can be mutated in order to update the permissions model attached to the object.

bucket = Bucket('default', auth=('alexis', 'p4ssw0rd'))

friends = ['natim', 'niko', 'mat', 'tarek']
bucket.permissions.write += friends
bucket.permissions.create_collection += friends

# You *need* to call save in order to have these changes reflected in the
# remote.
bucket.save()

Installation

To install the kinto client, use pip:

$ pip install kintoclient