Skip to content

Latest commit

 

History

History

python

README.md

Warning Deprecated - The client has been moved to https://github.com/iotaledger/iota-sdk

IOTA Client Library - Python binding

Python binding to the iota.rs client library.

Requirements

Python 3.x & pip

Rust and Cargo, to compile the binding. Install them here.

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.

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}')

Generate API References

You can generate the python API reference with the following command from this directory:

pip install pydoc-markdown && pydoc-markdown