# StatelyDB SDK for Python
This is the Python SDK for [StatelyDB](https://stately.cloud).
### Getting started:
##### Disclaimer:
We're still in an invite-only preview mode - if you're interested, please reach out to [preview@stately.cloud](mailto:preview@stately.cloud?subject=Early%20Access%20Program).
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
```
---
[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.12",
"maintainer_email": null,
"keywords": "stately, statelydb, statelycloud",
"author": "Stately Cloud",
"author_email": "support@stately.cloud",
"download_url": "https://files.pythonhosted.org/packages/95/95/0eab73137abe165cfe670d8d9cf69dc0c322d8f6b8c7ad1d1ee57829f974/statelydb-0.17.0.tar.gz",
"platform": null,
"description": "# StatelyDB SDK for Python\n\nThis is the Python SDK for [StatelyDB](https://stately.cloud).\n\n### Getting started:\n\n##### Disclaimer:\n\nWe're still in an invite-only preview mode - if you're interested, please reach out to [preview@stately.cloud](mailto:preview@stately.cloud?subject=Early%20Access%20Program).\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\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.17.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": "28df68708d1c9c17a84efc623b33348c39f181679635c818dec441dab28305e8",
"md5": "8cfaee9a12311c014a865b89f7a34393",
"sha256": "c8d0c69dac897c813af96b2219b81e7ca669b74ae8452b11018497a927a8859f"
},
"downloads": -1,
"filename": "statelydb-0.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cfaee9a12311c014a865b89f7a34393",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 65008,
"upload_time": "2025-01-24T19:51:55",
"upload_time_iso_8601": "2025-01-24T19:51:55.531364Z",
"url": "https://files.pythonhosted.org/packages/28/df/68708d1c9c17a84efc623b33348c39f181679635c818dec441dab28305e8/statelydb-0.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "95950eab73137abe165cfe670d8d9cf69dc0c322d8f6b8c7ad1d1ee57829f974",
"md5": "432f03339e526e3c8434683998e8208e",
"sha256": "3cad5076bdc5454403a049aa96075a09adb795a87cf84036d6f8029b0ad9501f"
},
"downloads": -1,
"filename": "statelydb-0.17.0.tar.gz",
"has_sig": false,
"md5_digest": "432f03339e526e3c8434683998e8208e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 39725,
"upload_time": "2025-01-24T19:51:58",
"upload_time_iso_8601": "2025-01-24T19:51:58.375837Z",
"url": "https://files.pythonhosted.org/packages/95/95/0eab73137abe165cfe670d8d9cf69dc0c322d8f6b8c7ad1d1ee57829f974/statelydb-0.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 19:51:58",
"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
