statelydb 0.30.0

Python client for StatelyDB API

StatelyDB SDK for Python

This is the Python SDK for StatelyDB. StatelyDB is a document database built on top of DynamoDB. It uses Elastic Schema to allow you to update your data model at any time, with automatic backwards and forwards compatibility.

Getting started:

Begin by following our Getting Started Guide which will help you define, generate, and publish a DB schema so that it can be used.

Install the SDK

pip install statelydb

Usage:

Create an authenticated client, then import your item types from your generated schema module and use the client!

from schema import Client, MyItem
async def put_my_item() -> None:
    # Create a client. This will use the environment variable
    # STATELY_ACCESS_KEY to read your access key.
    client = Client(store_id=<store-id>)

    # Instantiate an item from your schema
    item = MyItem(name="Jane Doe")

    # put and get the item!
    put_result = await client.put(item)
    get_result = await client.get(MyItem, put_result.key_path())
    assert put_result == get_result

    # Properly close the client to release
    # any network connections and resources.
    await client.close()

---