SUI client Python SDK
Reason this release was yanked:
Obsolete
Project description
pysui
Python Client SDK for Sui blockchain
- Supports SUI 1.16.x RPC API
- Backwards compatable to Sui 1.10.x RPC API
pysui SDK current (github)
Release-0.41.0
See CHANGELOG
PyPi current
Release-0.41.0
pysui SDK Dependencies
- Rust (stable) for installation of Sui Binaries (optional) and building
pysui-fastcrypto
Rust wrapper (required) - Python version >= 3.10
Sui GraphQL RPC service lies ahead
MystenLabs announcement can be found Here. This change transitions from JSON RPC to GraphQL RPC.
We will be changing pysui
to begin aligning with MystenLabs strategy. The timeline of changes will keep up with the Timeline as noted in their annoucement:
- December 2023: We will introduce a GraphQL
SuiClient
(experimental) and begin implementing parallel 'read' methods as found in the current SuiClient. - January 2024: Continue with SuiClient parity changes and expose underlying GraphQL for users to craft their own queries.
- February 2024: Deprecate pysui Builders and existing SuiClients and enable SuiClient GraphQL 'streaming' support.
- March 2024: Remove Builders and Obsolete SuiClients and bump pysui to version 1.0.0.
Documentation
Changelog
See CHANGELOG
Issues and enhancement requests
We would appreciate using the github issue log to let us know!
Release/Publish Strategy
See Strategies
Discord
Discord server click here:
Additions
There is a companion package called pysui-gadgets with a few utilities and ge-gaws that you may find interesting. It is a separate package also on on PyPi.
Local node support
We leverage suibase for our testing and SuiConfig includes an option for interacting directly with local nodes created by suibase
Ready to run
Requires:
- Linux or macos (x86_64 or Mx)
- Rust (stable) which also includes rustup and cargo
- python 3.10 or greater
- pkg-config
- libtool
- sui binaries to support
publish
Sui move packages
You will need suibase
for interacting with local nodes, it is an indispensible addition to Sui developers tools!
Setup environment
python3 -m venv env
If, instead, you want to work with repo latest source code then read DEVELOP from repo
Activate
source env/bin/activate
or
. env/bin/activate
Install pysui
pip install pysui
Samples
See samples
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.