Skip to main content

Python bindings for the IOTA client library

Project description

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

Build docs

pydoc-markdown -p iota_client > ../../../documentation/docs/libraries/python/api_reference.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

iota_client-1.0.0rc2-cp311-none-win_amd64.whl (4.3 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

iota_client-1.0.0rc2-cp311-cp311-manylinux_2_34_x86_64.whl (6.9 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.34+ x86-64

iota_client-1.0.0rc2-cp311-cp311-macosx_11_0_arm64.whl (4.7 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

iota_client-1.0.0rc2-cp311-cp311-macosx_10_7_x86_64.whl (5.1 MB view hashes)

Uploaded CPython 3.11 macOS 10.7+ x86-64

iota_client-1.0.0rc2-cp310-none-win_amd64.whl (4.3 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

iota_client-1.0.0rc2-cp310-cp310-manylinux_2_34_x86_64.whl (6.9 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.34+ x86-64

iota_client-1.0.0rc2-cp310-cp310-macosx_11_0_arm64.whl (4.7 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

iota_client-1.0.0rc2-cp310-cp310-macosx_10_7_x86_64.whl (5.1 MB view hashes)

Uploaded CPython 3.10 macOS 10.7+ x86-64

iota_client-1.0.0rc2-cp39-none-win_amd64.whl (4.3 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

iota_client-1.0.0rc2-cp39-cp39-manylinux_2_34_x86_64.whl (6.9 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.34+ x86-64

iota_client-1.0.0rc2-cp39-cp39-macosx_11_0_arm64.whl (4.7 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

iota_client-1.0.0rc2-cp39-cp39-macosx_10_7_x86_64.whl (5.1 MB view hashes)

Uploaded CPython 3.9 macOS 10.7+ x86-64

iota_client-1.0.0rc2-cp38-none-win_amd64.whl (4.3 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

iota_client-1.0.0rc2-cp38-cp38-manylinux_2_34_x86_64.whl (6.9 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.34+ x86-64

iota_client-1.0.0rc2-cp38-cp38-macosx_11_0_arm64.whl (4.7 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

iota_client-1.0.0rc2-cp38-cp38-macosx_10_7_x86_64.whl (5.1 MB view hashes)

Uploaded CPython 3.8 macOS 10.7+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page