Skip to main content
Version: IOTA

Getting Started with Python

Security​

note

In a production setup, do not store passwords in the host's environment variables or in the source code. For reference, review our backup and security recommendations for production setups.

Requirements​

Installation​

Install prebuild libraries​

To get the python binding working, you need to leverage pre-built python libraries for linux, MacOs, or Windows. You can install these to your python environment (3.6+) using pip . The binding is automatically generated using GitHub actions.

You can download the latest artifacts for a major python version using the nighly.link service.

  1. Download zip file for the given os and pyversion.
  2. Unpack wheel file ( .whl ).
  3. Install it via pip by running the following command:
pip install <wheel_file>

Install from source​

Additional Requirements​

  • Rust and Cargo.
  • (for Linux only) libudev. You can install it with apt install libudev-dev.

Clone the Repository​

You can clone the wallet.rs client library by running the following command:

git clone -b production https://github.com/iotaledger/wallet.rs

Change to the Python Binding Directory​

After you have cloned the repository, you should change directory to wallet.rs/bindings/python/native. You can do so by running the following command:

cd wallet.rs/bindings/python/native

Install the Required Dependencies and Build the Wheel​

Install and run maturin:

pip3 install maturin
maturin develop
maturin build --manylinux off

The wheel file is now created in bindings/python/native/target/wheels. You can install it with:

pip3 install [THE_BUILT_WHEEL_FILE]

Once it has been installed, you can double-check the installation using pip :

pip list

The pip list should now include the iota-wallet-python-binding:

Package                    Version
-------------------------- -------
iota-wallet-python-binding 0.1.0

Once your python environment has installed the iota-wallet-python-binding, you can start developing using the python binding.

Usage​

To use the iota_wallet you will need to add an import statement:

import iota_wallet

If you'd like more information on the iota_wallet, you can print the documentation using the following snippet:

print(iota_wallet.__doc__)