Metadata-Version: 2.1
Name: pysui
Version: 0.30.0
Summary: SUI client Python SDK
License: Apache-2.0
Project-URL: changelog, https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md
Project-URL: repository, https://github.com/FrankC01/pysui
Project-URL: issues, https://github.com/FrankC01/pysui/issues
Project-URL: documentation, https://pysui.readthedocs.io
Keywords: software development kit,sui,blockchain
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dataclasses-json (==0.5.7)
Requires-Dist: pyyaml (==6.0)
Requires-Dist: httpx (==0.24.1)
Requires-Dist: h2 (==4.1.0)
Requires-Dist: bip-utils (==2.7.0)
Requires-Dist: websockets (==11.0.3)
Requires-Dist: typing-utils (==0.1.0)
Requires-Dist: canoser (==0.8.2)
Requires-Dist: base58 (==2.1.1)
Requires-Dist: Deprecated (==1.2.14)
Requires-Dist: pyroaring (==0.4.2)

<img src="https://raw.githubusercontent.com/FrankC01/pysui/main/images//pysui_logo_color.png" width="150" height="200"/>

# pysui

Python Client SDK for Sui blockchain

**Release-0.30.0**

**BREAKING CHANGES** See CHANGELOG.md

- Supports _SUI 1.5.x/1.6.x RPC API_ on devnet
- Supports _SUI 1.5.x/1.6.x RPC API_ on testnet
- Supports _SUI 1.4.x/1.5.x RPC API_ on mainnet

**Deprecation Strategy**

Functions, classes and methods marked 'Deprecated' will be removed 2-3 releases after initial marking. Refer to
the CHANGELOG.md.

**Changelog**

See [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)

We would appreciate any issues being reported in the [github issue log](https://github.com/FrankC01/pysui/issues)

**Discord**

Discord server [click here](https://discord.gg/uCGYfY4Ph4):

**PyPi for 0.30.0**

- [Latest PyPi Version](https://pypi.org/project/pysui/)

## Documentation

- [ReadTheDocs](https://pysui.readthedocs.io/en/latest/index.html)

## Additions

There is a companion package called [pysui-gadgets](https://github.com/FrankC01/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've started leveraging [suibase](https://github.com/ChainMovers/suibase) in our testing and we've modified SuiConfig initialization to include an option for interacting directly with local nodes created by `suibase`

## Ready to run

Requires:

- Linux or macos (x86_64 or Mx)
- 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](https://github.com/FrankC01/pysui/blob/main/DEVELOP.md) from repo

### Activate

`source env/bin/activate`

or

`. env/bin/activate`

### Install `pysui`

`pip install pysui`

## Samples

See [samples](https://github.com/FrankC01/pysui/blob/main/samples/README.md)
