Stellar Python SDK
==================
.. image:: https://img.shields.io/github/actions/workflow/status/StellarCN/py-stellar-base/continuous-integration-workflow.yml?branch=main
:alt: GitHub Workflow Status
:target: https://github.com/StellarCN/py-stellar-base/actions
.. image:: https://img.shields.io/readthedocs/stellar-sdk.svg
:alt: Read the Docs
:target: https://stellar-sdk.readthedocs.io/en/latest/
.. image:: https://static.pepy.tech/personalized-badge/stellar-sdk?period=total&units=abbreviation&left_color=grey&right_color=brightgreen&left_text=Downloads
:alt: PyPI - Downloads
:target: https://pypi.python.org/pypi/stellar-sdk
.. image:: https://img.shields.io/codeclimate/maintainability/StellarCN/py-stellar-base
:alt: Code Climate maintainability
:target: https://codeclimate.com/github/StellarCN/py-stellar-base/maintainability
.. image:: https://img.shields.io/codecov/c/github/StellarCN/py-stellar-base/v2
:alt: Codecov
:target: https://codecov.io/gh/StellarCN/py-stellar-base
.. image:: https://img.shields.io/pypi/v/stellar-sdk.svg
:alt: PyPI
:target: https://pypi.python.org/pypi/stellar-sdk
.. image:: https://img.shields.io/badge/python-%3E%3D3.8-blue
:alt: Python - Version
:target: https://pypi.python.org/pypi/stellar-sdk
.. image:: https://img.shields.io/badge/implementation-cpython%20%7C%20pypy-blue
:alt: PyPI - Implementation
:target: https://pypi.python.org/pypi/stellar-sdk
.. image:: https://img.shields.io/badge/Stellar%20Protocol-22-blue
:alt: Stellar Protocol
:target: https://developers.stellar.org/docs/glossary/scp/
py-stellar-base is a Python library for communicating with
a `Stellar Horizon server`_ and `Soroban-RPC server`_. It is used for building Stellar apps on Python. It supports **Python 3.8+** as
well as PyPy 3.8+.
It provides:
- a networking layer API for Horizon endpoints.
- a networking layer API for Soroban-RPC server methods.
- facilities for building and signing transactions, for communicating with a Stellar Horizon and Soroban-RPC instance, and for submitting transactions or querying network history.
Documentation
-------------
py-stellar-base's documentation can be found at https://stellar-sdk.readthedocs.io.
Installing
----------
.. code-block:: text
pip install --upgrade stellar-sdk
If you need to use asynchronous, please use the following command to install the required dependencies.
.. code-block:: text
pip install --upgrade stellar-sdk[aiohttp]
We follow `Semantic Versioning 2.0.0 <https://semver.org/>`_, and I strongly
recommend that you specify its major version number in the dependency
file to avoid the unknown effects of breaking changes.
A Simple Example
----------------
You can find more examples `here <https://github.com/StellarCN/py-stellar-base/tree/main/examples>`__.
.. code-block:: python
# Alice pay 10.25 XLM to Bob
from stellar_sdk import Asset, Server, Keypair, TransactionBuilder, Network
alice_keypair = Keypair.from_secret("SBFZCHU5645DOKRWYBXVOXY2ELGJKFRX6VGGPRYUWHQ7PMXXJNDZFMKD")
bob_address = "GA7YNBW5CBTJZ3ZZOWX3ZNBKD6OE7A7IHUQVWMY62W2ZBG2SGZVOOPVH"
server = Server("https://horizon-testnet.stellar.org")
alice_account = server.load_account(alice_keypair.public_key)
base_fee = 100
transaction = (
TransactionBuilder(
source_account=alice_account,
network_passphrase=Network.TESTNET_NETWORK_PASSPHRASE,
base_fee=base_fee,
)
.add_text_memo("Hello, Stellar!")
.append_payment_op(bob_address, Asset.native(), "10.25")
.set_timeout(30)
.build()
)
transaction.sign(alice_keypair)
response = server.submit_transaction(transaction)
print(response)
stellar-contract-bindings
-------------------------
stellar-contract-bindings allows you to generate Python bindings for Stellar Soroban smart contracts, it makes calling
Stellar Soroban contracts easier. click `here <https://github.com/lightsail-network/stellar-contract-bindings>`__ for more information.
stellar-model
-------------
stellar-model allows you to parse the JSON returned by Stellar Horizon
into the Python models, click `here <https://github.com/StellarCN/stellar-model>`__ for more information.
Links
-----
* Document: https://stellar-sdk.readthedocs.io
* Code: https://github.com/StellarCN/py-stellar-base
* Examples: https://github.com/StellarCN/py-stellar-base/tree/main/examples
* Issue tracker: https://github.com/StellarCN/py-stellar-base/issues
* License: `Apache License 2.0 <https://github.com/StellarCN/py-stellar-base/blob/master/LICENSE>`_
* Releases: https://pypi.org/project/stellar-sdk/
Thank you to all the people who have already contributed to py-stellar-base!
.. _Stellar Horizon server: https://github.com/stellar/go/tree/master/services/horizon
.. _Soroban-RPC server: https://soroban.stellar.org/docs/reference/rpc
Raw data
{
"_id": null,
"home_page": "https://github.com/StellarCN/py-stellar-base",
"name": "stellar-sdk",
"maintainer": "overcat",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "4catcode@gmail.com",
"keywords": "stellar-sdk, stellar, stellar.org, lumens, xlm, blockchain, distributed exchange, cryptocurrency, dex, horizon, soroban, sdex, trading, soroban, soroban-rpc",
"author": "overcat",
"author_email": "4catcode@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/16/6d/046eca54bcf912b1164d700656ddda04ebe7653ac1b83eb362adcf6a6e96/stellar_sdk-12.0.0.tar.gz",
"platform": null,
"description": "Stellar Python SDK\n==================\n\n.. image:: https://img.shields.io/github/actions/workflow/status/StellarCN/py-stellar-base/continuous-integration-workflow.yml?branch=main\n :alt: GitHub Workflow Status\n :target: https://github.com/StellarCN/py-stellar-base/actions\n\n.. image:: https://img.shields.io/readthedocs/stellar-sdk.svg\n :alt: Read the Docs\n :target: https://stellar-sdk.readthedocs.io/en/latest/\n\n.. image:: https://static.pepy.tech/personalized-badge/stellar-sdk?period=total&units=abbreviation&left_color=grey&right_color=brightgreen&left_text=Downloads\n :alt: PyPI - Downloads\n :target: https://pypi.python.org/pypi/stellar-sdk\n\n.. image:: https://img.shields.io/codeclimate/maintainability/StellarCN/py-stellar-base\n :alt: Code Climate maintainability\n :target: https://codeclimate.com/github/StellarCN/py-stellar-base/maintainability\n\n.. image:: https://img.shields.io/codecov/c/github/StellarCN/py-stellar-base/v2\n :alt: Codecov\n :target: https://codecov.io/gh/StellarCN/py-stellar-base\n\n.. image:: https://img.shields.io/pypi/v/stellar-sdk.svg\n :alt: PyPI\n :target: https://pypi.python.org/pypi/stellar-sdk\n\n.. image:: https://img.shields.io/badge/python-%3E%3D3.8-blue\n :alt: Python - Version\n :target: https://pypi.python.org/pypi/stellar-sdk\n\n.. image:: https://img.shields.io/badge/implementation-cpython%20%7C%20pypy-blue\n :alt: PyPI - Implementation\n :target: https://pypi.python.org/pypi/stellar-sdk\n\n.. image:: https://img.shields.io/badge/Stellar%20Protocol-22-blue\n :alt: Stellar Protocol\n :target: https://developers.stellar.org/docs/glossary/scp/\n\npy-stellar-base is a Python library for communicating with\na `Stellar Horizon server`_ and `Soroban-RPC server`_. It is used for building Stellar apps on Python. It supports **Python 3.8+** as\nwell as PyPy 3.8+.\n\nIt provides:\n\n- a networking layer API for Horizon endpoints.\n- a networking layer API for Soroban-RPC server methods.\n- facilities for building and signing transactions, for communicating with a Stellar Horizon and Soroban-RPC instance, and for submitting transactions or querying network history.\n\nDocumentation\n-------------\npy-stellar-base's documentation can be found at https://stellar-sdk.readthedocs.io.\n\nInstalling\n----------\n\n.. code-block:: text\n\n pip install --upgrade stellar-sdk\n\nIf you need to use asynchronous, please use the following command to install the required dependencies.\n\n.. code-block:: text\n\n pip install --upgrade stellar-sdk[aiohttp]\n\nWe follow `Semantic Versioning 2.0.0 <https://semver.org/>`_, and I strongly\nrecommend that you specify its major version number in the dependency\nfile to avoid the unknown effects of breaking changes.\n\nA Simple Example\n----------------\nYou can find more examples `here <https://github.com/StellarCN/py-stellar-base/tree/main/examples>`__.\n\n.. code-block:: python\n\n # Alice pay 10.25 XLM to Bob\n from stellar_sdk import Asset, Server, Keypair, TransactionBuilder, Network\n\n alice_keypair = Keypair.from_secret(\"SBFZCHU5645DOKRWYBXVOXY2ELGJKFRX6VGGPRYUWHQ7PMXXJNDZFMKD\")\n bob_address = \"GA7YNBW5CBTJZ3ZZOWX3ZNBKD6OE7A7IHUQVWMY62W2ZBG2SGZVOOPVH\"\n\n server = Server(\"https://horizon-testnet.stellar.org\")\n alice_account = server.load_account(alice_keypair.public_key)\n base_fee = 100\n transaction = (\n TransactionBuilder(\n source_account=alice_account,\n network_passphrase=Network.TESTNET_NETWORK_PASSPHRASE,\n base_fee=base_fee,\n )\n .add_text_memo(\"Hello, Stellar!\")\n .append_payment_op(bob_address, Asset.native(), \"10.25\")\n .set_timeout(30)\n .build()\n )\n transaction.sign(alice_keypair)\n response = server.submit_transaction(transaction)\n print(response)\n\nstellar-contract-bindings\n-------------------------\nstellar-contract-bindings allows you to generate Python bindings for Stellar Soroban smart contracts, it makes calling\nStellar Soroban contracts easier. click `here <https://github.com/lightsail-network/stellar-contract-bindings>`__ for more information.\n\nstellar-model\n-------------\nstellar-model allows you to parse the JSON returned by Stellar Horizon\ninto the Python models, click `here <https://github.com/StellarCN/stellar-model>`__ for more information.\n\nLinks\n-----\n* Document: https://stellar-sdk.readthedocs.io\n* Code: https://github.com/StellarCN/py-stellar-base\n* Examples: https://github.com/StellarCN/py-stellar-base/tree/main/examples\n* Issue tracker: https://github.com/StellarCN/py-stellar-base/issues\n* License: `Apache License 2.0 <https://github.com/StellarCN/py-stellar-base/blob/master/LICENSE>`_\n* Releases: https://pypi.org/project/stellar-sdk/\n\nThank you to all the people who have already contributed to py-stellar-base!\n\n.. _Stellar Horizon server: https://github.com/stellar/go/tree/master/services/horizon\n.. _Soroban-RPC server: https://soroban.stellar.org/docs/reference/rpc\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The Python Stellar SDK library provides APIs to build transactions and connect to Horizon and Soroban-RPC server.",
"version": "12.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/StellarCN/py-stellar-base/issues",
"Documentation": "https://stellar-sdk.readthedocs.io/",
"Homepage": "https://github.com/StellarCN/py-stellar-base",
"Repository": "https://github.com/StellarCN/py-stellar-base"
},
"split_keywords": [
"stellar-sdk",
" stellar",
" stellar.org",
" lumens",
" xlm",
" blockchain",
" distributed exchange",
" cryptocurrency",
" dex",
" horizon",
" soroban",
" sdex",
" trading",
" soroban",
" soroban-rpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1500289e48952e5f039452602619c4d5dc12320e8df6f3b1ba6d90f4f183e583",
"md5": "24fda7bd21ae0a67b033ffa8eda7ab0e",
"sha256": "60814b7a2e2d68c4f1bdc147663fa1b4b30108aa563e49cf483b1a4ea7e887b7"
},
"downloads": -1,
"filename": "stellar_sdk-12.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24fda7bd21ae0a67b033ffa8eda7ab0e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 745711,
"upload_time": "2024-11-28T03:41:26",
"upload_time_iso_8601": "2024-11-28T03:41:26.915742Z",
"url": "https://files.pythonhosted.org/packages/15/00/289e48952e5f039452602619c4d5dc12320e8df6f3b1ba6d90f4f183e583/stellar_sdk-12.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "166d046eca54bcf912b1164d700656ddda04ebe7653ac1b83eb362adcf6a6e96",
"md5": "7277b342221dc9e3b2c4dfbd7baea81f",
"sha256": "0b14f1936bd386ddf57395b088427555ea64fc6ea9d9ca000128c6d7414a1856"
},
"downloads": -1,
"filename": "stellar_sdk-12.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7277b342221dc9e3b2c4dfbd7baea81f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 306639,
"upload_time": "2024-11-28T03:41:29",
"upload_time_iso_8601": "2024-11-28T03:41:29.385030Z",
"url": "https://files.pythonhosted.org/packages/16/6d/046eca54bcf912b1164d700656ddda04ebe7653ac1b83eb362adcf6a6e96/stellar_sdk-12.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-28 03:41:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StellarCN",
"github_project": "py-stellar-base",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stellar-sdk"
}
JSON
