Skip to main content

Python client for StatelyDB API

Project description

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()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

statelydb-0.27.2.tar.gz (45.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

statelydb-0.27.2-py3-none-any.whl (73.5 kB view details)

Uploaded Python 3

File details

Details for the file statelydb-0.27.2.tar.gz.

File metadata

  • Download URL: statelydb-0.27.2.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for statelydb-0.27.2.tar.gz
Algorithm Hash digest
SHA256 de7c2f3e3d5c672232736e02ef0d71fac200162ad42dad196c6003642fb895bb
MD5 9082ccb67999774b80d4f83e2e751941
BLAKE2b-256 5e93cf2513c6bba995d732a5ef38732859b0fd612ea377994f44a86e114f7d66

See more details on using hashes here.

Provenance

The following attestation bundles were made for statelydb-0.27.2.tar.gz:

Publisher: publish-python-sdk.yaml on StatelyCloud/stately

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file statelydb-0.27.2-py3-none-any.whl.

File metadata

  • Download URL: statelydb-0.27.2-py3-none-any.whl
  • Upload date:
  • Size: 73.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for statelydb-0.27.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fb38e8038e72610bd25be3a4aacd990b2388b0172e2e35fc7025f3943890322
MD5 9878f4e28d1e5f5e0d93724b8776213f
BLAKE2b-256 cdc54d648dc6f44262c737103c6639b2728c346e5db032ebe220195b4f20ed62

See more details on using hashes here.

Provenance

The following attestation bundles were made for statelydb-0.27.2-py3-none-any.whl:

Publisher: publish-python-sdk.yaml on StatelyCloud/stately

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page