aars 0.4.2

Experimental Object-Document-Mapper using pydantic to store objects on Aleph.im

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 Record class.

Usage

from aars import Record, Index, AARS


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


# initialize the SDK and post subsequent requests to the "MyLibrary" channel on Aleph
AARS(channel="MyLibrary")

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

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

# retrieve a book by its ID
book = await Book.fetch(new_book.id_hash)[0]

# retrieve a book by its title
book = await Book.where_eq(title='Atlas Shrugged')[0]

ToDo:

• Basic CRUD operations
• Versioning
  • Use "amend" post_type for updates
  • Fetch revisions with messages endpoint
• Basic indexing/querying operations
  • Single-key indexing
  • Multi-key indexing
  • Query with list of keys
  • Update indices function
  • Allow multiple items to share one index key
  • Add more comparators for where_() queries
    • where_gte()
    • where_lte()
    • where_contains()
  • Persist indices to lower startup time
• Automatic multi-page fetching
• Encapsulate Aleph SDK as class
• Local VM caching
• Add tests
• Add documentation
• Add to indices when fetching records
• Test where_eq() for fetching multiple records
• Add reindexing function on AARS
• Add caching of records
  • Cache records retrieved by item_hash
  • Cache records retrieved by fetch_all/timeline
    • Add item_hashes endpoint to pyaleph for quick cross-checking of cache hashes