voidfiles / lark

Lark is a RESTy interface for redis.

Lark is a RESTy interface for redis

Lark is a python library that provides a generic method from transforming a HTTP request into a redis command. If you have heard of webdis this works in roughly the same way. It provides two main framework specific methods for Django, and Flask. Though it should be easy to fit Lark into any python web framework.

Features

• Has a RESTy interface ie. POST for writes, GET for reads, and DELETE for, well, deletes
• Automatic JSON serialization and deserialization for redis values
• Automatic key prefixing for multi-user environments
• Fully tested adapters for Flask and Django
• Support for scope based authorization with an eye towards hooking up with flask-oauthlib
• While rough, documentation is available for all supported methods

Quickstart

To get started make sure that you have redis installed, then install lark.

pip install lark

Next you can create a simple Flask app that mounts the lark blueprint. Lark also comes with a Redis middleware for setting up redis connections.

from flask import Flask
from lark.ext.flask.redis_api import redis_api_blueprint
from lark.ext.flask.flask_redis import Redis

app = Flask(__name__)
# Add a simple redis connection to the global object
Redis(app)

app.config['DEFAULT_LARK_SCOPES'] = set(['admin'])

# Mount the redis blueprint
app.register_blueprint(redis_api_blueprint, url_prefix='/api/0')


if __name__ == '__main__':
    app.run()

Now you can run the server and then you will be able to interact with the API like so. You can find documentation on all the calls here.

>>> curl http://127.0.0.1:5000/api/0/get/a/
{"meta": {"status": "ok", "status_code": 200}


>>> curl -X POST -H 'Content-Type: application/json' \
--data-ascii '{"value": "foo"}' \
http://127.0.0.1:5000/api/0/set/a/
"meta": {"status": "ok", "status_code": 200}, "data": true}

>>> curl http://127.0.0.1:5000/api/0/get/a/
{"meta": {"status": "ok", "status_code": 200}, "data": "foo"}

Planned Features

• Flask middleware to support oauth2
• A full Web interface for managing, and editing redis values.

lark's Issues

Redis cluster support

Do you plan supporting Redis Cluster?
That would be a great feature. And a good use of REST style.

Document integration with Django

Conflict with this package and lark-parser

This package is imported with lark and so is lark-parser. I think that we should change the import name from lark to lark-redis or something like that to prevent conflicts.