NOTE: This repository is deprecated and will be continued to be developed here: AARS: Aleph Active Record SDK

AARS: Aleph Active Record SDK

AARS's goal is to provide simple guardrails for the creation of document databases, based on Aleph's decentralized storage API. It provides tools for modelling, creating and managing decentralized databases, and a set of extensions for the Aleph Python SDK.

You can create a model of your planned database by using the AlephRecord class.

from src.aars import Record, Index

class Book(Record):
    title: str
    author: str

# create and add an index for the book title
Index(Book, 'title')

# create & upload a book
new_book = await Book.create(title='Atlas Shrugged', author='Ayn Rand')

# assert the index works
assert new_book == (await Book.query(title='Atlas Shrugged'))[0]

ToDo:

• Basic CRUD operations
• Basic indexing operations
  • Single-key indexing
  • Multi-key indexing
• (IN PROGRESS) Basic search/filtering operations
• Handle pagination
• Encapsulate Aleph SDK as class
• Local caching
• (IN PROGRESS) Add tests
• (IN PROGRESS) Add documentation