# Python client for ceramic
A simple Ceramic Network client written in Python.
This Ceramic client implements the payload building, encoding and signing needed to interact with the [Ceramic Network](https://ceramic.network/).
# Run the example
The example in this repository creates a new stream in a remote Ceramic node. This stream is initialized with the following data: `{"hello": "world"}`. It then retrieves the data, submits an update request to change that data to `{"foo": "baz"}` and retrieves the data again to prove that the update was successful.
> Note: the Ceramic node used in this examples should be used for testing purposes only. All the data pinned to that node is wiped periodically.
* Install [pipenv](https://pipenv.pypa.io/en/latest/).
* Generate the virtual environment:
```
make new_env
```
* Run the example:
```
python example.py
```
You should see an output similar to the following:
```
Created stream kjzl6cwe1jw147sv2ak3kksfgs14gc3jgjhu3mfnwn534l89joxi2tulv0ci14k
Current data is {'hello': 'world'}
Updated stream kjzl6cwe1jw147sv2ak3kksfgs14gc3jgjhu3mfnwn534l89joxi2tulv0ci14k
Current data is {'foo': 'baz'}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/valory-xyz/ceramic-python-client.git",
"name": "ceramic-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Valory AG",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e6/03/a10bdfe133ae037fd8459db0d537131a7de00567d02459a32a7b7a1f3270/ceramic-py-0.1.0.tar.gz",
"platform": null,
"description": "# Python client for ceramic\n\nA simple Ceramic Network client written in Python.\n\nThis Ceramic client implements the payload building, encoding and signing needed to interact with the [Ceramic Network](https://ceramic.network/).\n\n# Run the example\n\nThe example in this repository creates a new stream in a remote Ceramic node. This stream is initialized with the following data: `{\"hello\": \"world\"}`. It then retrieves the data, submits an update request to change that data to `{\"foo\": \"baz\"}` and retrieves the data again to prove that the update was successful.\n\n> Note: the Ceramic node used in this examples should be used for testing purposes only. All the data pinned to that node is wiped periodically.\n\n* Install [pipenv](https://pipenv.pypa.io/en/latest/).\n* Generate the virtual environment:\n\n ```\n make new_env\n ```\n* Run the example:\n ```\n python example.py\n ```\n You should see an output similar to the following:\n\n ```\n Created stream kjzl6cwe1jw147sv2ak3kksfgs14gc3jgjhu3mfnwn534l89joxi2tulv0ci14k\n Current data is {'hello': 'world'}\n Updated stream kjzl6cwe1jw147sv2ak3kksfgs14gc3jgjhu3mfnwn534l89joxi2tulv0ci14k\n Current data is {'foo': 'baz'}\n ```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python client for ceramic streams.",
"version": "0.1.0",
"project_urls": {
"Bug Reports": "https://github.com/valory-xyz/ceramic-python-client/issues",
"Homepage": "https://github.com/valory-xyz/ceramic-python-client.git",
"Source": "https://github.com/valory/ceramic-python-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b4e117eaaa134474364a08b29972ac86b7877c7c9c70f486a7ddd05f5c638de",
"md5": "1edaee1c54df148bea6a678c689701ab",
"sha256": "82c72a35da73b1ada5ff135d49ec470cea08d377cc5524e13714324acdf33f05"
},
"downloads": -1,
"filename": "ceramic_py-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1edaee1c54df148bea6a678c689701ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10729,
"upload_time": "2023-06-15T09:34:22",
"upload_time_iso_8601": "2023-06-15T09:34:22.043610Z",
"url": "https://files.pythonhosted.org/packages/4b/4e/117eaaa134474364a08b29972ac86b7877c7c9c70f486a7ddd05f5c638de/ceramic_py-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e603a10bdfe133ae037fd8459db0d537131a7de00567d02459a32a7b7a1f3270",
"md5": "06db2639cac309d15f778b9f093368c8",
"sha256": "61228f883503f01130671647b3810442868983b59afc1900fd89c0d616fe3468"
},
"downloads": -1,
"filename": "ceramic-py-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "06db2639cac309d15f778b9f093368c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10547,
"upload_time": "2023-06-15T09:34:24",
"upload_time_iso_8601": "2023-06-15T09:34:24.166969Z",
"url": "https://files.pythonhosted.org/packages/e6/03/a10bdfe133ae037fd8459db0d537131a7de00567d02459a32a7b7a1f3270/ceramic-py-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 09:34:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "valory-xyz",
"github_project": "ceramic-python-client",
"github_not_found": true,
"lcname": "ceramic-py"
}
JSON
