# IOTA Client Library - Python binding
Python binding to the iota.rs client library.
## Requirements
[Python 3.x](https://www.python.org) & [pip](https://pypi.org/project/pip)
`Rust` and `Cargo`, to compile the binding. Install them [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
## Installation
- Go to `iota.rs/bindings/python`
### Create a virtual environment and use it (optional)
- `python3 -m venv iota_client_venv`
- `source iota_client_venv/bin/activate`; Windows: `.\iota_client_venv\Scripts\activate`
### Install required dependencies and build the wheel
- `pip install -r requirements-dev.txt`
- `pip install .`
### Run examples
`python3 examples/[example file]`
Example:
- `python3 examples/00_get_info.py`
### To deactivate the virtual environment (optional)
- `deactivate`
## Getting Started
After you installed the library, you can create a `IotaClient` instance and interface with it.
```python
from iota_client import IotaClient
# Create an IotaClient instance
client = IotaClient({'nodes': ['https://api.testnet.shimmer.network']})
# Get the node info
node_info = client.get_info()
print(f'{node_info}')
```
## Build docs
`pydoc-markdown -p iota_client > ../../../documentation/docs/libraries/python/api_reference.md`
Raw data
{
"_id": null,
"home_page": "https://www.iota.org/",
"name": "iota-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "iota,tangle,client,python",
"author": "IOTA Stiftung",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# IOTA Client Library - Python binding\n\nPython binding to the iota.rs client library.\n\n## Requirements\n\n[Python 3.x](https://www.python.org) & [pip](https://pypi.org/project/pip)\n\n`Rust` and `Cargo`, to compile the binding. Install them [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).\n\n## Installation\n\n- Go to `iota.rs/bindings/python`\n\n### Create a virtual environment and use it (optional)\n- `python3 -m venv iota_client_venv`\n- `source iota_client_venv/bin/activate`; Windows: `.\\iota_client_venv\\Scripts\\activate`\n\n### Install required dependencies and build the wheel\n- `pip install -r requirements-dev.txt`\n- `pip install .`\n\n### Run examples\n`python3 examples/[example file]`\n\nExample: \n- `python3 examples/00_get_info.py`\n\n### To deactivate the virtual environment (optional)\n- `deactivate`\n\n## Getting Started\n\nAfter you installed the library, you can create a `IotaClient` instance and interface with it.\n\n```python\nfrom iota_client import IotaClient\n\n# Create an IotaClient instance\nclient = IotaClient({'nodes': ['https://api.testnet.shimmer.network']})\n\n# Get the node info\nnode_info = client.get_info()\nprint(f'{node_info}')\n```\n\n## Build docs\n`pydoc-markdown -p iota_client > ../../../documentation/docs/libraries/python/api_reference.md`\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python bindings for the IOTA client library",
"version": "1.0.0rc2",
"split_keywords": [
"iota",
"tangle",
"client",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aad8192bc44d28d7915dce4c5d519d302c2314b0d033760ce258fe62341ed06c",
"md5": "d76437d56941186f6d7ddb3ca57da070",
"sha256": "7492b846ae8b4c767d5af39125efe19e8eba9f4d84e42d1526697cc14f07fb1f"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp310-cp310-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "d76437d56941186f6d7ddb3ca57da070",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 5135758,
"upload_time": "2023-02-09T09:38:18",
"upload_time_iso_8601": "2023-02-09T09:38:18.756325Z",
"url": "https://files.pythonhosted.org/packages/aa/d8/192bc44d28d7915dce4c5d519d302c2314b0d033760ce258fe62341ed06c/iota_client-1.0.0rc2-cp310-cp310-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a94bce5dbc79b9d3a7545c452101661597411794c3ee13265914055eb5d3aeaf",
"md5": "55c1d08426ce0a1a8764955f7b651168",
"sha256": "bf6b7efd7e938883ab0600545fbf527342f2163376cf01ae783ffda3977eb3ef"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "55c1d08426ce0a1a8764955f7b651168",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 4727749,
"upload_time": "2023-02-09T09:38:21",
"upload_time_iso_8601": "2023-02-09T09:38:21.476860Z",
"url": "https://files.pythonhosted.org/packages/a9/4b/ce5dbc79b9d3a7545c452101661597411794c3ee13265914055eb5d3aeaf/iota_client-1.0.0rc2-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8846ff8e36701733ec64d1f59efed83e409d072416425e9c5a68aa8debd92e68",
"md5": "1900a0b7bd3588285b272e98f86e95c8",
"sha256": "bb10bad4de5b5b3e35797b690fdfd500076d0b06cb4b84edd04e69f4467d83a1"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp310-cp310-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "1900a0b7bd3588285b272e98f86e95c8",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 6891262,
"upload_time": "2023-02-09T09:38:24",
"upload_time_iso_8601": "2023-02-09T09:38:24.086431Z",
"url": "https://files.pythonhosted.org/packages/88/46/ff8e36701733ec64d1f59efed83e409d072416425e9c5a68aa8debd92e68/iota_client-1.0.0rc2-cp310-cp310-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "573d9942f0021a12984507a8fc522255873f596943cc7f474e60b8ec282d512f",
"md5": "e97e806fc2e83d43d98772c53b16a35b",
"sha256": "cd905be665a8b88d9b711ed9e0e2fe304136ce3700b8ef839f9cb13dd7c6d125"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp310-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "e97e806fc2e83d43d98772c53b16a35b",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 4278284,
"upload_time": "2023-02-09T09:38:26",
"upload_time_iso_8601": "2023-02-09T09:38:26.478810Z",
"url": "https://files.pythonhosted.org/packages/57/3d/9942f0021a12984507a8fc522255873f596943cc7f474e60b8ec282d512f/iota_client-1.0.0rc2-cp310-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "260ff357dccd53500b6ac9c69b2179d4eea684f6d52d461a75a605b74b61f35b",
"md5": "2f4575984de68415efb1d0574a1ed2e9",
"sha256": "40e7c5ebba055231c10dfb813dabad1037b936973cc78003a51ec761f9ee230f"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp311-cp311-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "2f4575984de68415efb1d0574a1ed2e9",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 5135759,
"upload_time": "2023-02-09T09:38:28",
"upload_time_iso_8601": "2023-02-09T09:38:28.225733Z",
"url": "https://files.pythonhosted.org/packages/26/0f/f357dccd53500b6ac9c69b2179d4eea684f6d52d461a75a605b74b61f35b/iota_client-1.0.0rc2-cp311-cp311-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1da4446f82a116c2a39c285f2418d5157444dc3df7daaf4b9a8690fbdf340bd2",
"md5": "3427651268d138cf3a427da554ab646b",
"sha256": "227673f392e6e419bf1edbc08f874b2d0063901cd93821aa1dbb787ee7b22a0b"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "3427651268d138cf3a427da554ab646b",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 4727747,
"upload_time": "2023-02-09T09:38:30",
"upload_time_iso_8601": "2023-02-09T09:38:30.865518Z",
"url": "https://files.pythonhosted.org/packages/1d/a4/446f82a116c2a39c285f2418d5157444dc3df7daaf4b9a8690fbdf340bd2/iota_client-1.0.0rc2-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4bd3b865be2c2c5b3505b21d6a4baaa58accf4e0b06c7f9fbb117475334ed5f",
"md5": "703170cb297ddae7c8dcbce279c0d325",
"sha256": "cff06c57e0045359cc1b88c082adc55430fcfc52ff34bbbeb6615cc5f059e9f3"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp311-cp311-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "703170cb297ddae7c8dcbce279c0d325",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 6891159,
"upload_time": "2023-02-09T09:38:33",
"upload_time_iso_8601": "2023-02-09T09:38:33.188121Z",
"url": "https://files.pythonhosted.org/packages/e4/bd/3b865be2c2c5b3505b21d6a4baaa58accf4e0b06c7f9fbb117475334ed5f/iota_client-1.0.0rc2-cp311-cp311-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a66b20af401481c1a150b7ace046b576029c9d2fe422ee59485da9bf0872c8aa",
"md5": "98d1b5391090c5cf5d833fb061d8fc46",
"sha256": "60426a96188faeb144986ba0c3b8d9342c109a78f3816ea75cc1b07a8cfe8641"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp311-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "98d1b5391090c5cf5d833fb061d8fc46",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 4278285,
"upload_time": "2023-02-09T09:38:34",
"upload_time_iso_8601": "2023-02-09T09:38:34.905707Z",
"url": "https://files.pythonhosted.org/packages/a6/6b/20af401481c1a150b7ace046b576029c9d2fe422ee59485da9bf0872c8aa/iota_client-1.0.0rc2-cp311-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fc6fd4b9bf4e3445f1302abb7c7215659224dda3ea0ac1aff31119398269e5b",
"md5": "ad1f36eef19fa555ccba0766eeacf636",
"sha256": "7b80dfe72aa5ee10cfef92879ba4a913360fb3b2f8d353ecc18ad1a230edf0cf"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp38-cp38-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "ad1f36eef19fa555ccba0766eeacf636",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 5135726,
"upload_time": "2023-02-09T09:38:37",
"upload_time_iso_8601": "2023-02-09T09:38:37.531869Z",
"url": "https://files.pythonhosted.org/packages/0f/c6/fd4b9bf4e3445f1302abb7c7215659224dda3ea0ac1aff31119398269e5b/iota_client-1.0.0rc2-cp38-cp38-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f346c90cfdd92bae4b98774c4ab9df7909bf9e281002236a76549f0cbd9c3cbd",
"md5": "252890e7b60045fe31e47eac480c27bb",
"sha256": "892fed5f5b004e0dec9aa4d65150fd655e0c82ed1bc38d730fde84e81b7547a4"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp38-cp38-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "252890e7b60045fe31e47eac480c27bb",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 4727815,
"upload_time": "2023-02-09T09:38:40",
"upload_time_iso_8601": "2023-02-09T09:38:40.079319Z",
"url": "https://files.pythonhosted.org/packages/f3/46/c90cfdd92bae4b98774c4ab9df7909bf9e281002236a76549f0cbd9c3cbd/iota_client-1.0.0rc2-cp38-cp38-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd40fee97451d70f484e10a7ad98e4a51bb7251d5d35939c82e07a0b20364f10",
"md5": "377724c32a5757b47a80ab850033f1c5",
"sha256": "6291ea614278711981ba6069b681de2c61d52a7f4ac24f1dff792ba4a33d1d91"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp38-cp38-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "377724c32a5757b47a80ab850033f1c5",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 6890645,
"upload_time": "2023-02-09T09:38:41",
"upload_time_iso_8601": "2023-02-09T09:38:41.779472Z",
"url": "https://files.pythonhosted.org/packages/bd/40/fee97451d70f484e10a7ad98e4a51bb7251d5d35939c82e07a0b20364f10/iota_client-1.0.0rc2-cp38-cp38-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69a5aa8066a5f4faa576ffbbaed822bdf8a5c5cd5701695a47050e69844e9df3",
"md5": "182350d40b925b1435a6f0a1919e24d9",
"sha256": "52af2f2571233837aa492e303d1c4cb286a80909086bf5022ac4a6d3b4ca73e2"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp38-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "182350d40b925b1435a6f0a1919e24d9",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 4277321,
"upload_time": "2023-02-09T09:38:44",
"upload_time_iso_8601": "2023-02-09T09:38:44.179946Z",
"url": "https://files.pythonhosted.org/packages/69/a5/aa8066a5f4faa576ffbbaed822bdf8a5c5cd5701695a47050e69844e9df3/iota_client-1.0.0rc2-cp38-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1be75ff0c2bb411328bd057126f05bb0a89a2428551a26ec4f2a379f00dd6c9",
"md5": "64dfc705e08cbc46194d4125edd7f25b",
"sha256": "293893e35b29c79f89cefddeeef30091023a1c849ec66fd6da43994f40b4f3b8"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp39-cp39-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "64dfc705e08cbc46194d4125edd7f25b",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 5135681,
"upload_time": "2023-02-09T09:38:46",
"upload_time_iso_8601": "2023-02-09T09:38:46.787549Z",
"url": "https://files.pythonhosted.org/packages/c1/be/75ff0c2bb411328bd057126f05bb0a89a2428551a26ec4f2a379f00dd6c9/iota_client-1.0.0rc2-cp39-cp39-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1de3fc43c904ea5635127f60bfcb410faa8ad2295607053dcabc9f9055419e64",
"md5": "7138f49890ddf45382f68a66aa56f02d",
"sha256": "be355f6965111603874c4762f27269ef77aea51f81fa58dc6eac534b6020b22b"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp39-cp39-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "7138f49890ddf45382f68a66aa56f02d",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 4727925,
"upload_time": "2023-02-09T09:38:48",
"upload_time_iso_8601": "2023-02-09T09:38:48.871564Z",
"url": "https://files.pythonhosted.org/packages/1d/e3/fc43c904ea5635127f60bfcb410faa8ad2295607053dcabc9f9055419e64/iota_client-1.0.0rc2-cp39-cp39-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "187d6381014a157b3659e75360435d6a77a1df8862ba3ab516445bbb3d7aa341",
"md5": "9146ba09d793b6019ad59745dcdfdca8",
"sha256": "e1d299b7831df9cfee4e5bd3f53fcae3b6b50895ae164055357bd1828dbeee96"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp39-cp39-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "9146ba09d793b6019ad59745dcdfdca8",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 6891394,
"upload_time": "2023-02-09T09:38:51",
"upload_time_iso_8601": "2023-02-09T09:38:51.287459Z",
"url": "https://files.pythonhosted.org/packages/18/7d/6381014a157b3659e75360435d6a77a1df8862ba3ab516445bbb3d7aa341/iota_client-1.0.0rc2-cp39-cp39-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "679c84b2f43a981068120e1d7c7a9eae38427893eeec477d18ff77986dba2d51",
"md5": "b2c9fb49a5e8fe42a201e98afacbe84f",
"sha256": "cc15061320cb2cabddf36ca1c43021b6a60b9748d1cf8fa2346b86713f62a6e8"
},
"downloads": -1,
"filename": "iota_client-1.0.0rc2-cp39-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "b2c9fb49a5e8fe42a201e98afacbe84f",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 4278558,
"upload_time": "2023-02-09T09:38:53",
"upload_time_iso_8601": "2023-02-09T09:38:53.618208Z",
"url": "https://files.pythonhosted.org/packages/67/9c/84b2f43a981068120e1d7c7a9eae38427893eeec477d18ff77986dba2d51/iota_client-1.0.0rc2-cp39-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-09 09:38:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "iota-client"
}
JSON