friendlydb is a fast & small following/followers database written in Python. It can be either used directly from your Python code or over HTTP with small web API.
FriendlyDB isn't meant to be a full user system; it should be used to augment an existing system to track relationships.
Usage
Using FriendlyDB from Python looks like:
from friendlydb.db import FriendlyDB
# Give Friendly a directory to work in.
fdb = FriendlyDB('/usr/data/friendly')
# Grab a user by their username.
daniel = fdb['daniel']
# Follow a couple users.
daniel.follow('alice')
daniel.follow('bob')
daniel.follow('joe')
# Check the following.
daniel.following()
# Returns:
# [
# 'alice',
# 'bob',
# 'joe',
# ]
# Check joe's followers.
fdb['joe'].followers()
# Returns:
# [
# 'daniel',
# ]
# Unfollow.
daniel.unfollow('bob')
# Check the following.
daniel.following()
# Returns:
# [
# 'alice',
# 'joe',
# ]
# Dust off & nuke everything from orbit.
fdb.clear()
Using FriendlyDB from HTTP looks like (all trailing slashes are optional):
# In one shell, start the server.
python friendlydb/server.py
# From another, run some URLs.
curl -X GET http://127.0.0.1:8008/
# {"version": "0.3.0"}
curl -X GET http://127.0.0.1:8008/daniel/
# {"username": "daniel", "following": [], "followers": []}
curl -X POST http://127.0.0.1:8008/daniel/follow/alice/
# {"username": "daniel", "other_username": "alice", "followed": true}
curl -X POST http://127.0.0.1:8008/daniel/follow/bob/
# {"username": "daniel", "other_username": "bob", "followed": true}
curl -X POST http://127.0.0.1:8008/daniel/follow/joe/
# {"username": "daniel", "other_username": "joe", "followed": true}
curl -X POST http://127.0.0.1:8008/daniel/unfollow/joe/
# {"username": "daniel", "other_username": "joe", "unfollowed": true}
curl -X GET http://127.0.0.1:8008/daniel/
# {"username": "daniel", "following": ["alice", "bob"], "followers": []}
curl -X GET http://127.0.0.1:8008/daniel/is_following/alice/
# {"username": "daniel", "other_username": "alice", "is_following": true}
curl -X GET http://127.0.0.1:8008/alice/is_followed_by/daniel/
# {"username": "alice", "other_username": "daniel", "is_followed_by": true}
curl -X GET http://127.0.0.1:8008/alice/is_followed_by/joe/
# {"username": "alice", "other_username": "joe", "is_followed_by": false}
Installation
Using pip, you can install it with pip install friendlydb.
Performance
You can scope out FriendlyDB's performance for yourself by running the included benchmark.py script.
In tests on a 2011 MacBook Pro (i7), the benchmark script demonstrated:
- created 1,000,000 relationships between 10,000 users: 7.3 minutes
- avg time to fetch a user's followers: 0.0008 seconds
- never exceeding 40Mb of RAM RSS
Running Tests
friendlydb is maintained with passing tests at all times. Simply run:
python -m unittest2 tests
Requirements:
- Python
- (Optional) gevent for the HTTP server
- (Optional) unittest2 for running tests
Comments not found