Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Lark is a RESTy interface for python

Project Description

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.


  • Has a RESTy interface ie. POST for writes, GET for reads, and DELETE for, well, deletes
  • Automatic JSON serilization and deserialization for redis values
  • Automatic key prefixing for multi-user environments
  • Fully tested adapaters 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


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 simpple redis connection to the global object

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

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

if __name__ == '__main__':

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
{"meta": {"status": "ok", "status_code": 200}

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

>>> curl
{"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.

Release History

This version
History Node


History Node


History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(11.9 kB) Copy SHA256 Hash SHA256
Source None Dec 21, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting