Skip to content
An ORM for S3
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ssshelf
tests
.codeclimate.yml
.editorconfig
.gitignore
.travis.yml
Dockerfile
LICENSE
Makefile
README.rst
requirements.txt
setup.py
test_requirements.txt
todo

README.rst

SSShelf

https://travis-ci.org/voidfiles/ssshelf.svg?branch=master Code Climate Test Coverage

An S3 persistence manager. If you squint closely enough you could even call it a database.

Goals

  • Lots of examples
  • Blob Storage as primary (S3, Ceph, Google Cloud Storage, etc.)

Concerns

  • Eventual Consistency
  • Speed
  • Constraints

Examples Using SSShelf

Example

import asyncio
from datetime import datetime
import simpleflake
import json

from ssshelf.items import IManager
from ssshelf.collections import Collection
from ssshelf.utils import convert_datetime_to_str, json_dump
from ssshelf.managers import CManager
from ssshelf.storages.s3 import S3Storage


class Bookmark(IManager):
    def get_pk(self, item):
        return str(item['pk'])

    def serialize_item(self, item):
        return bytes(json_dump(item), 'utf8')

    def deserialize_item(self, data):
        return json.loads(data)


class AllBookmarks(Collection):
    def get_pk(self, item):
        return str(item['pk'])

    def key(self, item):
        return [
          [convert_datetime_to_str(item['created_at'])]
        ]


class BookmarkManager(CManager):
    item_manager = Bookmark()
    every = AllBookmarks()

async def demo():
    bookmark_manager = BookmarkManager(S3Storage())

    bookmark = {
        'pk': simpleflake.simpleflake(),
        'link': 'http://google.com',
        'created_at': datetime.utcnow()
    }

    await bookmark_manager.add_item(bookmark)

    resp = await bookmark_manager.every.get_items()

    assert resp['items'][0]['link'] == 'http://google.com'

loop = asyncio.get_event_loop()
loop.run_until_complete(demo())
You can’t perform that action at this time.