Hiero SDK in Python

A Python SDK for interacting with the Hedera Hashgraph platform.

[!NOTE] Python compatibility

The SDK supports Python ≥ 3.10 and is tested on Python 3.10–3.14. Newer Python versions may work but have not yet been validated.

Quick Start

Installing from PyPI

pip install --upgrade pip
pip install hiero-sdk-python
pip install python-dotenv

Environment Configuration

Create a .env file in your project root with your Hedera testnet credentials.

Full setup instructions: Setup Guide

Don't have testnet credentials? Get them free at Hedera Portal

A sample file is provided: .env.example

Basic Usage

import os
from dotenv import load_dotenv
from hiero_sdk_python import Network, Client, CryptoGetAccountBalanceQuery, AccountId, PrivateKey

# Connect to testnet
load_dotenv()
network = Network("testnet")
client = Client(network)

operator_id = AccountId.from_string(os.getenv("OPERATOR_ID",""))
operator_key = PrivateKey.from_string(os.getenv("OPERATOR_KEY",""))

client.set_operator(operator_id, operator_key)

# Query account balance
balance = CryptoGetAccountBalanceQuery(account_id=operator_id).execute(client)
print(f"Balance: {balance.hbars} HBAR")

Documentation

For SDK Users

• Running Examples - Complete guide to all SDK operations with code examples
• Error Handling - Exception types, response codes, and retry guidance
• Examples Directory - Ready-to-run example scripts

For SDK Developers

• Contributing Guide - Start here!
• Setup Guide - First-time environment setup
• Windows Setup Guide - Step-by-step guide for Windows users
• Workflow Guide - Day-to-day development workflow
• Signing Guide - GPG and DCO commit signing (required)
• Rebasing Guide - Keep your branch up-to-date
• Merge Conflicts Guide - Resolve conflicts
• Typing Guide - Python type hints
• Linting Guide - Code quality tools
• Security Analysis - Security analysis & vulnerability scanning

Hedera Network Resources

• Hedera Documentation
• Hedera Protobufs
• Get Testnet Account - Free testnet credentials
• Hedera Testnet Guide

Other SDKs

• Hiero JavaScript SDK
• Hiero Java SDK
• Hiero Go SDK

Running Tests

uv run pytest

For contributors: Tests run automatically via Hiero Solo Action when you push to a branch.

Learn more:

• Testing with Hiero Solo

Community & Support

Get Help

• Discord: - Linux Foundation Decentralized Trust Discord (signed in users can use this direct link to the Python SDK Channel)
• General Hedera Support: - Hedera Developer Discord
• Issues: GitHub Issues

Stay Updated

• Blog: Hiero Blog
• Videos: LFDT YouTube Channel
• Community Calls: Hiero Calendar (Wednesdays, 2pm UTC)

⭐ Follow Us

If you find the Hiero Python SDK useful, here are three ways you can support the project and stay up-to-date on the official repository page: hiero-ledger/hiero-sdk-python.

• Star the Repository: Click Star to bookmark the project and show your support.
• Watch for Activity: Click Watch to set your notification level, ensuring you stay updated on new features and releases.
• Fork the Project: Click Fork to create your own copy, the first step for contributions.

Contributions

We welcome contributions! Whether you're:

• 🐛 Reporting bugs
• 💡 Suggesting features
• 📝 Improving documentation
• 💻 Writing code

Start here: CONTRIBUTING.md

Pull Request Reviews

We welcome community reviews on our PRs. Please use this link PR Review Guidelines to find a detailed guide on reviewing PRs.

License

This project is licensed under the Apache License 2.0.

Latest release: Check PyPI or GitHub Releases