iota-sdk 1.0.0

Python bindings for the IOTA SDK library

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
  • Client
  • Wallet
  • Examples
  • API Reference
  • Learn More

Requirements

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

Getting Started

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:

   '''bash python3 -m venv iota_sdk_venv source iota_sdk_venv/bin/activate '''

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

   .\iota_sdk_venv\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.

from iota_sdk import Client

# Create a Client instance
client = Client(nodes=['https://api.testnet.shimmer.network'])

# Get the node info
node_info = client.get_info()
print(f'{node_info}')

Wallet Usage

The following example will create a new Wallet Account that connects to the Shimmer Testnet using the StrongholdSecretManager to safely store a seed derived from a mnemonic, and then print the account's information.

from iota_sdk import Wallet, StrongholdSecretManager, CoinType

# This example creates a new database and account

wallet_options = {
    'nodes': ['https://api.testnet.shimmer.network'],
}

secret_manager = StrongholdSecretManager("wallet.stronghold", "some_hopefully_secure_password")

wallet = Wallet('./alice-walletdb', wallet_options, coin_type=CoinType.SHIMMER, secret_manager)

# Store the mnemonic in the Stronghold snapshot. This only needs to be done once
account = wallet.store_mnemonic("flame fever pig forward exact dash body idea link scrub tennis minute " +
          "surge unaware prosper over waste kitten ceiling human knife arch situate civil")

account = wallet.create_account('Alice')
print(account.get_metadata())

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.