Python SDK
A Python Client SDK for interacting with the Sui blockchain via JSON-RPC, GraphQL, and gRPC.
What is Python SDK?
PySui is a Python Client SDK for the Sui blockchain that enables developers to interact with Sui's network through multiple protocols including JSON-RPC, GraphQL, and gRPC. It provides tools for querying blockchain data, executing programmable transactions, and managing Sui addresses, simplifying the development of decentralized applications on Sui.
Python developers building applications, tools, or services on the Sui blockchain, including those needing programmatic access for queries, transactions, or integrations.
Developers choose PySui for its comprehensive multi-protocol support (JSON-RPC, GraphQL, gRPC), Pythonic design, and strong local development features via suibase integration, offering a flexible and well-documented SDK for Sui.
Overview
SUI Python Client SDK
Use Cases
Best For
- Building Python applications that interact with the Sui blockchain
- Developing tools for querying Sui blockchain data via GraphQL or gRPC
- Executing programmable transactions on Sui programmatically
- Testing Sui applications locally with suibase integration
- Managing Sui addresses and balances in Python scripts
- Creating SDKs or libraries that require multi-protocol blockchain access
Not Ideal For
- Projects requiring stable, production-ready GraphQL or gRPC support for mission-critical operations
- Developers working in non-Python ecosystems or preferring JavaScript/TypeScript tooling
- Simple scripts or quick prototypes that don't need multi-protocol blockchain access
- Teams unwilling to manage Rust dependencies or handle binary installations for pysui-fastcrypto
Pros & Cons
Pros
Supports JSON-RPC, GraphQL (beta), and gRPC (beta) for diverse interaction methods, allowing developers to choose the best protocol for their use case as highlighted in the README.
Enables creation and execution of complex transactions on Sui programmatically, which is essential for advanced dApp development according to the key features.
Integrates with suibase tools for local node testing via JSON-RPC, facilitating easier debugging and development workflows as noted in the README.
Offers full documentation on ReadTheDocs with detailed guides and examples, improving onboarding and reducing development friction as mentioned in the features.
Cons
GraphQL and gRPC support are marked as beta in the README, meaning they may be unstable, lack features, or have breaking changes unsuitable for production.
Requires Rust or manual binary downloads for pysui-fastcrypto, adding complexity compared to standard pip installs, as outlined in the installation steps.
Local node support via suibase does not extend to GraphQL, restricting its use for local testing with that protocol, as admitted in the README.
Frequently Asked Questions
Related Projects
Golang SDK 2Go language SDK for @MystenLabs Sui
Golang SDK 1Sui Golang SDK @mystenLabs
Java SDKSui4j is a robust, reactive, type safe Java library for working with Smart Contracts on the @MystenLabs/sui network.
Kotlin SDKSUI Android SDK(beta)
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.