Skip to main content

The Python Stellar SDK library provides APIs to build transactions and connect to Horizon and Soroban-RPC server.

Project description

GitHub Workflow Status Read the Docs PyPI - Downloads Maintainability Codecov PyPI Python - Version PyPI - Implementation Stellar Protocol

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

pip install --upgrade stellar-sdk

If you need to use asynchronous, please use the following command to install the required dependencies.

pip install --upgrade stellar-sdk[aiohttp]

We follow Semantic Versioning 2.0.0, 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.

# 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 for more information.

stellar-model

stellar-model allows you to parse the JSON returned by Stellar Horizon into the Python models, click here for more information.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stellar_sdk-12.3.0.tar.gz (297.7 kB view details)

Uploaded Source

Built Distribution

stellar_sdk-12.3.0-py3-none-any.whl (750.4 kB view details)

Uploaded Python 3

File details

Details for the file stellar_sdk-12.3.0.tar.gz.

File metadata

  • Download URL: stellar_sdk-12.3.0.tar.gz
  • Upload date:
  • Size: 297.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for stellar_sdk-12.3.0.tar.gz
Algorithm Hash digest
SHA256 b6b83a718bef320af10fcf2a7b97bfc7b4d2c29c15ca829cb9a73cb499f14049
MD5 d9afa4197326c195a06d44bb8778b1f6
BLAKE2b-256 1fd02ab68c1c61abc5ae7219f5850e2d575a48e30ea9b20a30e31d9c9c21a79e

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellar_sdk-12.3.0.tar.gz:

Publisher: continuous-integration-workflow.yml on StellarCN/py-stellar-base

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stellar_sdk-12.3.0-py3-none-any.whl.

File metadata

  • Download URL: stellar_sdk-12.3.0-py3-none-any.whl
  • Upload date:
  • Size: 750.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for stellar_sdk-12.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23bd63877680d5287b497c4a449f2580deed3a339c7d6f13f271424ce057613e
MD5 40d067af677fe371eb4bdebed63cbf9b
BLAKE2b-256 2fa8ca114520769740f50ac1c1aa6a68a304da7a8a743a164e61537cb78e07f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellar_sdk-12.3.0-py3-none-any.whl:

Publisher: continuous-integration-workflow.yml on StellarCN/py-stellar-base

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page