starknet-py-unbroken


Namestarknet-py-unbroken JSON
Version 0.24.5 PyPI version JSON
download
home_pagehttps://github.com/software-mansion/starknet.py
SummaryA python SDK for Starknet
upload_time2024-08-30 18:06:13
maintainerNone
docs_urlNone
authorTomasz Rejowski
requires_python<3.13,>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <div align="center">
    <img src="https://raw.githubusercontent.com/software-mansion/starknet.py/master/graphic.png" alt="starknet.py"/>
</div>
<h2 align="center">Starknet SDK for Python</h2>

<div align="center">

[![codecov](https://codecov.io/gh/software-mansion/starknet.py/branch/master/graph/badge.svg?token=3E54E8RYSL)](https://codecov.io/gh/software-mansion/starknet.py)
[![pypi](https://img.shields.io/pypi/v/starknet.py)](https://pypi.org/project/starknet.py/)
[![build](https://img.shields.io/github/actions/workflow/status/software-mansion/starknet.py/checks.yml)](https://github.com/software-mansion/starknet.py/actions)
[![docs](https://readthedocs.org/projects/starknetpy/badge/?version=latest)](https://starknetpy.readthedocs.io/en/latest/?badge=latest)
[![license](https://img.shields.io/badge/license-MIT-black)](https://github.com/software-mansion/starknet.py/blob/master/LICENSE.txt)
[![stars](https://img.shields.io/github/stars/software-mansion/starknet.py?color=yellow)](https://github.com/software-mansion/starknet.py/stargazers)
[![starkware](https://img.shields.io/badge/powered_by-StarkWare-navy)](https://starkware.co)

</div>

## 📘 Documentation

- [Installation](https://starknetpy.rtfd.io/en/latest/installation.html)
- [Quickstart](https://starknetpy.rtfd.io/en/latest/quickstart.html)
- [Guide](https://starknetpy.rtfd.io/en/latest/guide.html)
- [API](https://starknetpy.rtfd.io/en/latest/api.html)
- [Migration guide](https://starknetpy.readthedocs.io/en/latest/migration_guide.html)

## ⚙️ Installation

Installation varies between operating systems.

[See our documentation on complete instructions](https://starknetpy.rtfd.io/en/latest/installation.html)

## ▶️ Example usage

### Asynchronous API

This is the recommended way of using the SDK.

```python
from starknet_py.contract import Contract
from starknet_py.net.full_node_client import FullNodeClient

contract = await Contract.from_address(
    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
    client=FullNodeClient(node_url="https://your.node.url"),
)
(value,) = await contract.functions["get_balance"].call()
```

### Synchronous API

You can access synchronous world with `_sync` postfix.

```python
from starknet_py.contract import Contract
from starknet_py.net.full_node_client import FullNodeClient

contract = Contract.from_address_sync(
    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
    client=FullNodeClient(node_url="https://your.node.url"),
)
(value,) = contract.functions["get_balance"].call_sync()
```

For more examples click [here](https://starknetpy.rtfd.io/en/latest/quickstart.html).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/software-mansion/starknet.py",
    "name": "starknet-py-unbroken",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Tomasz Rejowski",
    "author_email": "tomasz.rejowski@swmansion.com",
    "download_url": "https://files.pythonhosted.org/packages/09/94/8f27b6a91d53d959ea0e67a7fdac6c524dd237a13a3631a88e901711974a/starknet_py_unbroken-0.24.5.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <img src=\"https://raw.githubusercontent.com/software-mansion/starknet.py/master/graphic.png\" alt=\"starknet.py\"/>\n</div>\n<h2 align=\"center\">Starknet SDK for Python</h2>\n\n<div align=\"center\">\n\n[![codecov](https://codecov.io/gh/software-mansion/starknet.py/branch/master/graph/badge.svg?token=3E54E8RYSL)](https://codecov.io/gh/software-mansion/starknet.py)\n[![pypi](https://img.shields.io/pypi/v/starknet.py)](https://pypi.org/project/starknet.py/)\n[![build](https://img.shields.io/github/actions/workflow/status/software-mansion/starknet.py/checks.yml)](https://github.com/software-mansion/starknet.py/actions)\n[![docs](https://readthedocs.org/projects/starknetpy/badge/?version=latest)](https://starknetpy.readthedocs.io/en/latest/?badge=latest)\n[![license](https://img.shields.io/badge/license-MIT-black)](https://github.com/software-mansion/starknet.py/blob/master/LICENSE.txt)\n[![stars](https://img.shields.io/github/stars/software-mansion/starknet.py?color=yellow)](https://github.com/software-mansion/starknet.py/stargazers)\n[![starkware](https://img.shields.io/badge/powered_by-StarkWare-navy)](https://starkware.co)\n\n</div>\n\n## \ud83d\udcd8 Documentation\n\n- [Installation](https://starknetpy.rtfd.io/en/latest/installation.html)\n- [Quickstart](https://starknetpy.rtfd.io/en/latest/quickstart.html)\n- [Guide](https://starknetpy.rtfd.io/en/latest/guide.html)\n- [API](https://starknetpy.rtfd.io/en/latest/api.html)\n- [Migration guide](https://starknetpy.readthedocs.io/en/latest/migration_guide.html)\n\n## \u2699\ufe0f Installation\n\nInstallation varies between operating systems.\n\n[See our documentation on complete instructions](https://starknetpy.rtfd.io/en/latest/installation.html)\n\n## \u25b6\ufe0f Example usage\n\n### Asynchronous API\n\nThis is the recommended way of using the SDK.\n\n```python\nfrom starknet_py.contract import Contract\nfrom starknet_py.net.full_node_client import FullNodeClient\n\ncontract = await Contract.from_address(\n    address=\"0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73\",\n    client=FullNodeClient(node_url=\"https://your.node.url\"),\n)\n(value,) = await contract.functions[\"get_balance\"].call()\n```\n\n### Synchronous API\n\nYou can access synchronous world with `_sync` postfix.\n\n```python\nfrom starknet_py.contract import Contract\nfrom starknet_py.net.full_node_client import FullNodeClient\n\ncontract = Contract.from_address_sync(\n    address=\"0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73\",\n    client=FullNodeClient(node_url=\"https://your.node.url\"),\n)\n(value,) = contract.functions[\"get_balance\"].call_sync()\n```\n\nFor more examples click [here](https://starknetpy.rtfd.io/en/latest/quickstart.html).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python SDK for Starknet",
    "version": "0.24.5",
    "project_urls": {
        "Documentation": "https://starknetpy.rtfd.io/",
        "Homepage": "https://github.com/software-mansion/starknet.py",
        "Repository": "https://github.com/software-mansion/starknet.py"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3a364707c3684b91de130dc6914f2d68b20ea3e57d51d1c3a976bdb027910836",
                "md5": "9116065703196c1566de3439f91b0cf6",
                "sha256": "8e968170a45223894bec16001bae41cf39d4e3848d141632fa80153249ce6739"
            },
            "downloads": -1,
            "filename": "starknet_py_unbroken-0.24.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9116065703196c1566de3439f91b0cf6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.8",
            "size": 138614,
            "upload_time": "2024-08-30T18:06:10",
            "upload_time_iso_8601": "2024-08-30T18:06:10.910713Z",
            "url": "https://files.pythonhosted.org/packages/3a/36/4707c3684b91de130dc6914f2d68b20ea3e57d51d1c3a976bdb027910836/starknet_py_unbroken-0.24.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "09948f27b6a91d53d959ea0e67a7fdac6c524dd237a13a3631a88e901711974a",
                "md5": "77db124f93916035a6b8ab063ae01c01",
                "sha256": "489cd0cb69f5d5880a33dad5c172739d2e0bc42662571ed9491e8bc780677ce4"
            },
            "downloads": -1,
            "filename": "starknet_py_unbroken-0.24.5.tar.gz",
            "has_sig": false,
            "md5_digest": "77db124f93916035a6b8ab063ae01c01",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.8",
            "size": 92512,
            "upload_time": "2024-08-30T18:06:13",
            "upload_time_iso_8601": "2024-08-30T18:06:13.069994Z",
            "url": "https://files.pythonhosted.org/packages/09/94/8f27b6a91d53d959ea0e67a7fdac6c524dd237a13a3631a88e901711974a/starknet_py_unbroken-0.24.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-30 18:06:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "software-mansion",
    "github_project": "starknet.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "starknet-py-unbroken"
}
Tomasz Rejowski
Elapsed time: 1.70920s