Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A persistent, full-text searchable key-value store. Powered by Flask, ElasticSearch, and good intentions.
Python
Branch: master
Failed to load latest commit information.
.gitignore always ignore t.py
Procfile 6 of em
README.rst PUBLIC_ALLOWED
elephant.py Merge remote-tracking branch 'origin/master'
requirements.txt +
runtime.txt targetting pypy

README.rst

Elephant

Elephant is an S3-backed key-value store with querying powered by Elastic Search. Your data is persisted on S3 as simple JSON documents, but you can instantly query it over HTTP.

Suddenly, your data becomes as durable as S3, as portable as JSON, and as queryable as HTTP. Enjoy!

Usage

>>> requests.post('http://elephant-server/', data={'title': 'Test Page', 'draft': True})
<Response [200]>

>>> requests.get('http://elephant-server/', params={'q': 'draft:True'}).json()
{u'records': [{u'epoch': 1364286524987, u'title': u'Test Post', u'uuid': u'ce251e8a-ab6b-4f7e-bdc4-eecf0e71ac16'}}

Configuration

Elephant expects the following environment variables to be set:

# AWS Credentials
AWS_ACCESS_KEY_ID = xxxxxx
AWS_SECRET_ACCESS_KEY = xxxxxx

# Elastic Search Server
ELASTICSEARCH_URL = xxxxxx

# Instance Name
CLUSTER_NAME = xxxxxx

# Instance Password
API_KEY = xxxxxx

Optional Configuration:

# Write to local files instead of S3
AIRPLANE_MODE = 1

# Allow the public to query the dataset without authentication.
PUBLIC_ALLOWED = 1

# Custom S3 Bucket Name
TODO: S3_BUCKET_NAME

# Custom DynamoDB Name
TODO: DYNAMODB_NAME

If you need a production Elastic Search instance, checkout SearchBox.io and heroku-elasticsearch.

Management

Reseeding ElasticSearch is super simple:

$ python elephant.py seed
Creating Index...
Indexing...
[####                            ] 29/378

Inspiration

Extracted out of the in-progress blackbox project.

Something went wrong with that request. Please try again.