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

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.0.tar.gz (45.2 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.0-py3-none-any.whl (73.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: statelydb-0.27.0.tar.gz
  • Upload date:
  • Size: 45.2 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.0.tar.gz
Algorithm Hash digest
SHA256 d149612aa0888a0af80d6d289a3ffb4fbbac1b27171e76f16e2c2a3dc6be3703
MD5 f55e65a87da37019de7c3190429e5b1b
BLAKE2b-256 e8863ab054f6fd1689d4ac1b938bc50bd40054b51324020ddb0e2459e8d2feac

See more details on using hashes here.

Provenance

The following attestation bundles were made for statelydb-0.27.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: statelydb-0.27.0-py3-none-any.whl
  • Upload date:
  • Size: 73.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e620750134e2a8b391491571106366935b712e21a3494ed29caadd34518f3fcf
MD5 6b631cc5f92b2064b9904e7db9838df5
BLAKE2b-256 acad1b8be0197715e822e66f515459fa71ede4b75760e0bd7fb7c5a671b690be

See more details on using hashes here.

Provenance

The following attestation bundles were made for statelydb-0.27.0-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