brine-starknet-py


Namebrine-starknet-py JSON
Version 0.18.6 PyPI version JSON
download
home_pagehttps://github.com/software-mansion/starknet.py
SummaryA python SDK for Starknet
upload_time2023-11-16 06:41:43
maintainer
docs_urlNone
authorTomasz Rejowski
requires_python>=3.8,<3.12
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.gateway_client import GatewayClient

contract = await Contract.from_address(
    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
    client=GatewayClient("testnet"),
)
(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.gateway_client import GatewayClient

contract = Contract.from_address_sync(
    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
    client=GatewayClient("testnet"),
)
(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": "brine-starknet-py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Tomasz Rejowski",
    "author_email": "tomasz.rejowski@swmansion.com",
    "download_url": "https://files.pythonhosted.org/packages/a4/b7/54d2a999b4f5d952e932b191f661b79168f8e1140972dcb1ba2639ab478c/brine_starknet_py-0.18.6.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.gateway_client import GatewayClient\n\ncontract = await Contract.from_address(\n    address=\"0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73\",\n    client=GatewayClient(\"testnet\"),\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.gateway_client import GatewayClient\n\ncontract = Contract.from_address_sync(\n    address=\"0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73\",\n    client=GatewayClient(\"testnet\"),\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.18.6",
    "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": "23b3cb7ed144ac350d4b76b521b950941e824615e96628d2cad48be2e3a9bdf0",
                "md5": "8e38100832f8b063b0e1079dd541dec0",
                "sha256": "0a66b80f6fbd96ca128ad7b41e78e0706b64a60807bee9bc1ec7ccdf2aecb394"
            },
            "downloads": -1,
            "filename": "brine_starknet_py-0.18.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8e38100832f8b063b0e1079dd541dec0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<3.12",
            "size": 120744,
            "upload_time": "2023-11-16T06:41:41",
            "upload_time_iso_8601": "2023-11-16T06:41:41.375247Z",
            "url": "https://files.pythonhosted.org/packages/23/b3/cb7ed144ac350d4b76b521b950941e824615e96628d2cad48be2e3a9bdf0/brine_starknet_py-0.18.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4b754d2a999b4f5d952e932b191f661b79168f8e1140972dcb1ba2639ab478c",
                "md5": "aa03ec82df68518f80240dba594272ad",
                "sha256": "9b9851fb8b0d7efb3be34604ab6e64dd79d3d3339974cb6be8e1b795ceefaf6a"
            },
            "downloads": -1,
            "filename": "brine_starknet_py-0.18.6.tar.gz",
            "has_sig": false,
            "md5_digest": "aa03ec82df68518f80240dba594272ad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<3.12",
            "size": 78053,
            "upload_time": "2023-11-16T06:41:43",
            "upload_time_iso_8601": "2023-11-16T06:41:43.610441Z",
            "url": "https://files.pythonhosted.org/packages/a4/b7/54d2a999b4f5d952e932b191f661b79168f8e1140972dcb1ba2639ab478c/brine_starknet_py-0.18.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-16 06:41:43",
    "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": "brine-starknet-py"
}
Tomasz Rejowski
Elapsed time: 0.20105s