# About
Python-chianode is a Python wrapper for [Chia blockchain](https://www.chia.net) full node APIs.
The package supports the [official RPC API](https://docs.chia.net/full-node-rpc) for Chia nodes running on localhost, as well as the [Mojonode API](https://api.mojonode.com/docs). Calls are made asynchronously, and it is possible to receive streaming responses.
Mojonode provides advanced REST calls not available via the official RPC interface, blockchain data via SQL query, and an event stream for blockchain and mempool events. Note that Mojonode does not implement all official RPCs. The ```get_routes``` endpoint returns a list of available endpoints.
# Installation
To install python-chianode, run
```pip install python-chianode```
# Quick start
Import and instantiate the Chia node client in your Python file as follows
```
from chianode.mojoclient import MojoClient
node = MojoClient()
```
By default, both MojoClient and RpcClient connect to Mojonode. To connect to a local node only, do
```
from chianode.rpcclient import RpcClient
from chianode.constants import LOCALHOST
node = RpcClient(base_url=LOCALHOST)
```
To use Mojonode in conjunction with a local node, do
```
from chianode.mojoclient import MojoClient
from chianode.constants import LOCALHOST
node = MojoClient(base_url=LOCALHOST)
```
More detailed examples on how to use the wrapper can be found in ```example_rpc.py``` and ```example_events.py``` files.
Raw data
{
"_id": null,
"home_page": "https://github.com/circuitdao/python-chianode",
"name": "python-chianode",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "Chia,blockchain,node,full node,wrapper,API",
"author": "CircuitDAO",
"author_email": "info@circuitdao.com",
"download_url": "https://files.pythonhosted.org/packages/72/3d/08c6c7426c2545d0ad8458b102f283b8d6caf7f6edeba5cc313f9583778b/python_chianode-0.1.1.tar.gz",
"platform": null,
"description": "# About\n\nPython-chianode is a Python wrapper for [Chia blockchain](https://www.chia.net) full node APIs.\n\nThe package supports the [official RPC API](https://docs.chia.net/full-node-rpc) for Chia nodes running on localhost, as well as the [Mojonode API](https://api.mojonode.com/docs). Calls are made asynchronously, and it is possible to receive streaming responses.\n\nMojonode provides advanced REST calls not available via the official RPC interface, blockchain data via SQL query, and an event stream for blockchain and mempool events. Note that Mojonode does not implement all official RPCs. The ```get_routes``` endpoint returns a list of available endpoints.\n\n# Installation\n\nTo install python-chianode, run\n\n```pip install python-chianode```\n\n# Quick start\n\nImport and instantiate the Chia node client in your Python file as follows\n\n```\nfrom chianode.mojoclient import MojoClient\n\nnode = MojoClient()\n```\n\nBy default, both MojoClient and RpcClient connect to Mojonode. To connect to a local node only, do\n```\nfrom chianode.rpcclient import RpcClient\nfrom chianode.constants import LOCALHOST\n\nnode = RpcClient(base_url=LOCALHOST)\n```\n\nTo use Mojonode in conjunction with a local node, do\n```\nfrom chianode.mojoclient import MojoClient\nfrom chianode.constants import LOCALHOST\n\nnode = MojoClient(base_url=LOCALHOST)\n```\n\nMore detailed examples on how to use the wrapper can be found in ```example_rpc.py``` and ```example_events.py``` files.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for Chia blockchain node APIs",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/python-poetry/poetry/issues",
"Homepage": "https://github.com/circuitdao/python-chianode"
},
"split_keywords": [
"chia",
"blockchain",
"node",
"full node",
"wrapper",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27504be30f02fa84d831c27e365ca564d586779a1a140de7d8b8f35028008c45",
"md5": "f0359e97317fcd9740c6c6c42ed80eac",
"sha256": "f1a2cd4e0bd315541cfd8555d645e7fec993ecff735a12ee448d5df1407d66d0"
},
"downloads": -1,
"filename": "python_chianode-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0359e97317fcd9740c6c6c42ed80eac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 9177,
"upload_time": "2023-08-23T12:19:31",
"upload_time_iso_8601": "2023-08-23T12:19:31.631463Z",
"url": "https://files.pythonhosted.org/packages/27/50/4be30f02fa84d831c27e365ca564d586779a1a140de7d8b8f35028008c45/python_chianode-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "723d08c6c7426c2545d0ad8458b102f283b8d6caf7f6edeba5cc313f9583778b",
"md5": "9ea1c8350fa5cf4550dd2829a59133ce",
"sha256": "f1861099a4ed025e9bc4f7ba17d9124783ead7a50e9da5014a40b628ede2da7f"
},
"downloads": -1,
"filename": "python_chianode-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9ea1c8350fa5cf4550dd2829a59133ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 8063,
"upload_time": "2023-08-23T12:19:32",
"upload_time_iso_8601": "2023-08-23T12:19:32.710840Z",
"url": "https://files.pythonhosted.org/packages/72/3d/08c6c7426c2545d0ad8458b102f283b8d6caf7f6edeba5cc313f9583778b/python_chianode-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-23 12:19:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "circuitdao",
"github_project": "python-chianode",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python-chianode"
}
JSON
