README.md

IOTA SDK Library - Python binding

Python binding to the iota-sdk library.

Table of contents

• IOTA SDK Library - Python binding
  • Table of contents
  • Requirements
  • Getting Started
    • Install the IOTA SDK via pip
    • Install the IOTA SDK
  • Client
  • Wallet
  • Examples
  • API Reference
  • Learn More

Requirements

• Python 3.9+
• pip ^21.x
• Rust and Cargo to compile the binding. Install them here.

Getting Started

Install IOTA SDK via pip

1. (optional) Create a virtual environment and use it. On Linux and macOS, you can run the following commands:

   python3 -m venv env
   source env/bin/activate

   If you are using Windows, you should run the following instead:

   python3 -m venv env
   .\env\Scripts\activate

2. Install the IOTA-SDK using pip:

   pip install iota-sdk

3. (optional) If you want to deactivate the virtual environment, run the following command:

   deactivate

Install the IOTA SDK

1. Move to the Python bindings directory:

   cd iota-sdk/bindings/python

2. (optional) Create a virtual environment and use it. On Linux and macOS, you can run the following commands:

   python3 -m venv env
   source env/bin/activate

   If you are using Windows, you should run the following instead:

   python3 -m venv env
   .\env\Scripts\activate

3. Install the required dependencies and build the wheel by running the following commands:

   pip install -r requirements-dev.txt
   pip install .

4. (optional) If you want to deactivate the virtual environment, run the following command:

   deactivate

Client Usage

The following example creates a Client instance connected to the Shimmer Testnet, and retrieves the node's information by calling Client.get_info(), and then print the node's information.

examples/client/getting_started.py

Wallet Usage

The following example will create a new Wallet Account using a StrongholdSecretManager, and then print the account's information.

examples/wallet/getting_started.py

Examples

You can use the provided code examples to acquainted with the IOTA SDK. You can use the following command to run any example:

python3 example/[example file]

• Where [example file] is the file name from the example folder. For example:

python3 examples/client/00_get_info.py

API Reference

You can find the API reference for the Python bindings in the IOTA Wiki.

Learn More

To learn more about Rust, see the Rust documentation.