<p align="center">
<img width="150" height="200" src="https://raw.githubusercontent.com/FrankC01/pysui/main/images//pysui_logo_color.png" alt='PySui'>
</p>
# pysui
[](https://pepy.tech/project/pysui)
Python Client SDK for Sui blockchain
## pysui SDK Dependencies
- Rust (stable) for installation of Sui Binaries (optional) and building `pysui-fastcrypto` Rust wrapper (required)
- Python version >= 3.10
**Note**: If moving from 0.51.0 or earlier it is recommended to start a new virtual environment and installing from PyPi!
## pysui SDK current (github)
**Release-0.74.0**
- Supports _SUI 1.40.x JSON RPC API_, _SUI 1.40.x GRAPHQL_
- JSON RPC API backwards compatable to _Sui 1.33.x_
Adds beta `SerialTransactionExecutor`
See [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)
## PyPi current
**Release-0.74.0 - Released 2024-12-24**
- Supports _SUI 1.40.x JSON RPC API_, _SUI 1.40.x GRAPHQL_
- JSON RPC API backwards compatable to _Sui 1.33.x_
Adds beta `SerialTransactionExecutor` Here are the initial [docs](https://pysui.readthedocs.io/en/latest/graphql_serial_exc.html)
- [Latest PyPi Version](https://pypi.org/project/pysui/)
## Sui GraphQL RPC beta
MystenLabs announcement can be found [Here](https://github.com/mystenLabs/sui/issues/13700). This change transitions
from JSON RPC to GraphQL RPC.
Note: MystenLabs/Sui GraphQL RPC is available on devnet, testnet and mainnet. Note that devnet beta is usable but
we recommend using testnet or mainnet beta for stability. We are tracking a few failures we are monitoring [Isssues](https://github.com/FrankC01/pysui/issues?q=is%3Aissue+is%3Aopen++Sui+GraphQL+RPC).
### Sui GraphQL IDEs
[Mainnet](https://sui-mainnet.mystenlabs.com/graphql)
[Testnet](https://sui-testnet.mystenlabs.com/graphql)
[Devnet](https://sui-devnet.mystenlabs.com/graphql)
### pysui GraphQL support
**Note**: Functionality of pysui GraphQl should be considered beta, use in production is at your own risk.
With pysui 0.50.0 we released beta `pysui`'s beta alignment with MystenLabs strategy. The timeline of changes will keep up with the Timeline as noted in the Sui GraphQL annoucement. We are not yet stable however we have Clients and TransactionBuilder running against Sui GraphQL.
We continue to monitor and support changes from MystenLabs as they occur.
#### Examples
- **_pgql_s_example_** - Synchronous examples for all supported QueryNode queries and mutations
- **_pgql_a_example_** - Asynchronous examples for all supported QueryNode queries and mutations
- **_pgql_s_ptb_** - Example of new pysui Transaction Builder leveraging Sui GraphQL
You can read pysui documentation on graphql beta [here](https://pysui.readthedocs.io/en/latest/graphql.html)
#### Known Issues
- No subscription support at this time
### FULL Documentation
- [ReadTheDocs](https://pysui.readthedocs.io/en/latest/index.html)
### Changelog
See [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)
### Issues and enhancement requests
We would appreciate using the [github issue log](https://github.com/FrankC01/pysui/issues) to let us know!
### Release/Publish Strategy
See [Strategies](https://github.com/FrankC01/pysui/blob/main/OP_STRATEGIES.md)
### Discord
Discord server [click here](https://discord.gg/uCGYfY4Ph4):
### 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 leverage [suibase](https://github.com/ChainMovers/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](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)
Raw data
{
"_id": null,
"home_page": null,
"name": "pysui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "software development kit, sui, blockchain",
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "<p align=\"center\">\n <img width=\"150\" height=\"200\" src=\"https://raw.githubusercontent.com/FrankC01/pysui/main/images//pysui_logo_color.png\" alt='PySui'>\n</p>\n\n# pysui\n\n[](https://pepy.tech/project/pysui)\n\nPython Client SDK for Sui blockchain\n\n## pysui SDK Dependencies\n\n- Rust (stable) for installation of Sui Binaries (optional) and building `pysui-fastcrypto` Rust wrapper (required)\n- Python version >= 3.10\n\n**Note**: If moving from 0.51.0 or earlier it is recommended to start a new virtual environment and installing from PyPi!\n\n## pysui SDK current (github)\n\n**Release-0.74.0**\n\n- Supports _SUI 1.40.x JSON RPC API_, _SUI 1.40.x GRAPHQL_\n- JSON RPC API backwards compatable to _Sui 1.33.x_\n\nAdds beta `SerialTransactionExecutor`\n\nSee [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)\n\n## PyPi current\n\n**Release-0.74.0 - Released 2024-12-24**\n\n- Supports _SUI 1.40.x JSON RPC API_, _SUI 1.40.x GRAPHQL_\n- JSON RPC API backwards compatable to _Sui 1.33.x_\n\nAdds beta `SerialTransactionExecutor` Here are the initial [docs](https://pysui.readthedocs.io/en/latest/graphql_serial_exc.html)\n\n- [Latest PyPi Version](https://pypi.org/project/pysui/)\n\n## Sui GraphQL RPC beta\n\nMystenLabs announcement can be found [Here](https://github.com/mystenLabs/sui/issues/13700). This change transitions\nfrom JSON RPC to GraphQL RPC.\n\nNote: MystenLabs/Sui GraphQL RPC is available on devnet, testnet and mainnet. Note that devnet beta is usable but\nwe recommend using testnet or mainnet beta for stability. We are tracking a few failures we are monitoring [Isssues](https://github.com/FrankC01/pysui/issues?q=is%3Aissue+is%3Aopen++Sui+GraphQL+RPC).\n\n### Sui GraphQL IDEs\n\n [Mainnet](https://sui-mainnet.mystenlabs.com/graphql)\n\n [Testnet](https://sui-testnet.mystenlabs.com/graphql)\n\n [Devnet](https://sui-devnet.mystenlabs.com/graphql)\n\n### pysui GraphQL support\n\n**Note**: Functionality of pysui GraphQl should be considered beta, use in production is at your own risk.\n\nWith pysui 0.50.0 we released beta `pysui`'s beta alignment with MystenLabs strategy. The timeline of changes will keep up with the Timeline as noted in the Sui GraphQL annoucement. We are not yet stable however we have Clients and TransactionBuilder running against Sui GraphQL.\n\nWe continue to monitor and support changes from MystenLabs as they occur.\n\n#### Examples\n\n - **_pgql_s_example_** - Synchronous examples for all supported QueryNode queries and mutations\n - **_pgql_a_example_** - Asynchronous examples for all supported QueryNode queries and mutations\n - **_pgql_s_ptb_** - Example of new pysui Transaction Builder leveraging Sui GraphQL\n\nYou can read pysui documentation on graphql beta [here](https://pysui.readthedocs.io/en/latest/graphql.html)\n\n#### Known Issues\n- No subscription support at this time\n\n\n### FULL Documentation\n\n- [ReadTheDocs](https://pysui.readthedocs.io/en/latest/index.html)\n\n### Changelog\n\nSee [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)\n\n### Issues and enhancement requests\n\nWe would appreciate using the [github issue log](https://github.com/FrankC01/pysui/issues) to let us know!\n\n### Release/Publish Strategy\n\nSee [Strategies](https://github.com/FrankC01/pysui/blob/main/OP_STRATEGIES.md)\n\n### Discord\n\nDiscord server [click here](https://discord.gg/uCGYfY4Ph4):\n\n### Additions\n\nThere 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.\n\n### Local node support\n\nWe leverage [suibase](https://github.com/ChainMovers/suibase) for our testing and SuiConfig includes an option for interacting directly with local nodes created by `suibase`\n\n## Ready to run\n\nRequires:\n\n- Linux or macos (x86_64 or Mx)\n- Rust (stable) which also includes rustup and cargo\n- python 3.10 or greater\n- pkg-config\n- libtool\n- sui binaries to support `publish` Sui move packages\n\nYou will need `suibase` for interacting with local nodes, it is an indispensible addition to Sui developers tools!\n\n### Setup environment\n\n`python3 -m venv env`\n\nIf, instead, you want to work with repo latest source code then read [DEVELOP](https://github.com/FrankC01/pysui/blob/main/DEVELOP.md) from repo\n\n### Activate\n\n`source env/bin/activate`\n\nor\n\n`. env/bin/activate`\n\n### Install `pysui`\n\n`pip install pysui`\n\n## Samples\n\nSee [samples](https://github.com/FrankC01/pysui/blob/main/samples/README.md)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "SUI client Python SDK",
"version": "0.74.0",
"project_urls": {
"changelog": "https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md",
"documentation": "https://pysui.readthedocs.io",
"issues": "https://github.com/FrankC01/pysui/issues",
"repository": "https://github.com/FrankC01/pysui"
},
"split_keywords": [
"software development kit",
" sui",
" blockchain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6fe2f9f7c0b8bb378a1dfe26a904b9b35f231e834c5e345ca628f49b8bc19c2a",
"md5": "cd3e0c8174f88539f1a40be864d34096",
"sha256": "77100d606e0fce778b6a22dee9afc66faf5c33b6bdfd659d79abfce6cb53fce8"
},
"downloads": -1,
"filename": "pysui-0.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd3e0c8174f88539f1a40be864d34096",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 268214,
"upload_time": "2024-12-24T11:21:04",
"upload_time_iso_8601": "2024-12-24T11:21:04.678194Z",
"url": "https://files.pythonhosted.org/packages/6f/e2/f9f7c0b8bb378a1dfe26a904b9b35f231e834c5e345ca628f49b8bc19c2a/pysui-0.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 11:21:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FrankC01",
"github_project": "pysui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "dataclasses_json",
"specs": [
[
"<",
"0.7.0"
],
[
">=",
"0.6.6"
]
]
},
{
"name": "pyyaml",
"specs": [
[
">=",
"6.0.1"
],
[
"<",
"6.2"
]
]
},
{
"name": "httpx",
"specs": [
[
"<",
"0.28"
],
[
">=",
"0.27.0"
]
]
},
{
"name": "h2",
"specs": [
[
"<",
"5"
],
[
">=",
"4.1.0"
]
]
},
{
"name": "pysui-fastcrypto",
"specs": [
[
">=",
"0.5.0"
]
]
},
{
"name": "gql",
"specs": [
[
">=",
"3.5.0"
]
]
},
{
"name": "websockets",
"specs": [
[
"<",
"13.0.0"
],
[
">=",
"10.0.0"
]
]
},
{
"name": "typing_utils",
"specs": [
[
">=",
"0.1.0"
],
[
"<",
"0.2.0"
]
]
},
{
"name": "canoser",
"specs": [
[
"<",
"0.9.0"
],
[
">=",
"0.8.0"
]
]
},
{
"name": "base58",
"specs": [
[
"<",
"2.2.0"
],
[
">=",
"2.1.0"
]
]
},
{
"name": "Deprecated",
"specs": [
[
"<",
"1.3.0"
],
[
">=",
"1.2.0"
]
]
}
],
"lcname": "pysui"
}
JSON
