# StatelyDB SDK for Python
This is the Python SDK for [StatelyDB](https://stately.cloud). 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
```sh
pip install statelydb
```
### Usage:
Create an authenticated client, then import your item types from your generated schema module and use the client!
```python
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()
```
---
[Getting Started Guide]: https://docs.stately.cloud/guides/getting-started/
[Defining Schema]: https://docs.stately.cloud/guides/schema/
Raw data
{
"_id": null,
"home_page": "https://stately.cloud",
"name": "statelydb",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "stately, statelydb, statelycloud",
"author": "Stately Cloud",
"author_email": "support@stately.cloud",
"download_url": "https://files.pythonhosted.org/packages/f7/fb/982be5ca64b1d29e9c942a1b4bae5eda60e5fd5fe824c724be07bb9001c4/statelydb-0.29.0.tar.gz",
"platform": null,
"description": "# StatelyDB SDK for Python\n\nThis is the Python SDK for [StatelyDB](https://stately.cloud). 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.\n\n### Getting started:\n\nBegin by following our [Getting Started Guide] which will help you define, generate, and publish a DB schema so that it can be used.\n\n##### Install the SDK\n\n```sh\npip install statelydb\n```\n\n\n### Usage:\n\nCreate an authenticated client, then import your item types from your generated schema module and use the client!\n\n```python\nfrom schema import Client, MyItem\nasync def put_my_item() -> None:\n # Create a client. This will use the environment variable\n # STATELY_ACCESS_KEY to read your access key.\n client = Client(store_id=<store-id>)\n\n # Instantiate an item from your schema\n item = MyItem(name=\"Jane Doe\")\n\n # put and get the item!\n put_result = await client.put(item)\n get_result = await client.get(MyItem, put_result.key_path())\n assert put_result == get_result\n\n # Properly close the client to release\n # any network connections and resources.\n await client.close()\n```\n\n---\n\n[Getting Started Guide]: https://docs.stately.cloud/guides/getting-started/\n[Defining Schema]: https://docs.stately.cloud/guides/schema/\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python client for StatelyDB API",
"version": "0.29.0",
"project_urls": {
"Documentation": "https://docs.stately.cloud",
"Homepage": "https://stately.cloud",
"Repository": "https://github.com/StatelyCloud/python-sdk"
},
"split_keywords": [
"stately",
" statelydb",
" statelycloud"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c31a78ce4610fb175b713232f565a1cc18c48f0366f28c0213ad09d3a4ffca89",
"md5": "de488637ab5c8f1b1f8ac4f146c95d88",
"sha256": "9ec8330e4f0ec20b8fe20d27835cb32322b046c356d5416ef664c13d0b923d93"
},
"downloads": -1,
"filename": "statelydb-0.29.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de488637ab5c8f1b1f8ac4f146c95d88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 72399,
"upload_time": "2025-08-27T18:54:46",
"upload_time_iso_8601": "2025-08-27T18:54:46.745933Z",
"url": "https://files.pythonhosted.org/packages/c3/1a/78ce4610fb175b713232f565a1cc18c48f0366f28c0213ad09d3a4ffca89/statelydb-0.29.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f7fb982be5ca64b1d29e9c942a1b4bae5eda60e5fd5fe824c724be07bb9001c4",
"md5": "a987863e4a0ee89a01c8aa0bbf15be75",
"sha256": "0b71dac909855346fbcd897493656716e5f8166a2978791e12ac8dd447630493"
},
"downloads": -1,
"filename": "statelydb-0.29.0.tar.gz",
"has_sig": false,
"md5_digest": "a987863e4a0ee89a01c8aa0bbf15be75",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 45511,
"upload_time": "2025-08-27T18:54:48",
"upload_time_iso_8601": "2025-08-27T18:54:48.478038Z",
"url": "https://files.pythonhosted.org/packages/f7/fb/982be5ca64b1d29e9c942a1b4bae5eda60e5fd5fe824c724be07bb9001c4/statelydb-0.29.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 18:54:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StatelyCloud",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "statelydb"
}
JSON
