Skip to content

Latest commit

 

History

History
90 lines (50 loc) · 2.27 KB

README.md

File metadata and controls

90 lines (50 loc) · 2.27 KB
Raw

PySui

pysui

Python Client SDK for Sui blockchain

  • Supports SUI 1.10.x RPC API
  • Backwards compatable to Sui 1.6.x RPC API

pysui SDK Dependencies

  • Rust (stable) for installation of Sui Binaries (optional) and building pysui-fastcrypto Rust wrapper (required)
  • Python version >= 3.10

Release/Publish Strategy

See Strategies

pysui SDK current (github)

Release-0.35.0

See CHANGELOG

PyPi current

Release-0.35.0

Documentation

Changelog

See CHANGELOG

Issues and enhancement requests

We would appreciate using the github issue log to let us know!

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