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 Code Climate 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-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.0.0b2.tar.gz (299.6 kB view details)

Uploaded Source

Built Distribution

stellar_sdk-12.0.0b2-py3-none-any.whl (731.2 kB view details)

Uploaded Python 3

File details

Details for the file stellar_sdk-12.0.0b2.tar.gz.

File metadata

  • Download URL: stellar_sdk-12.0.0b2.tar.gz
  • Upload date:
  • Size: 299.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for stellar_sdk-12.0.0b2.tar.gz
Algorithm Hash digest
SHA256 6b225626d8cbd5f70db0486f99592713ff88acd3e2c99f3ddab07d1ebeef7b5b
MD5 97e836f4ae35b27b1e6770e9d02e5dd0
BLAKE2b-256 4cc25df72716aecedae6d6a4800e58644949f64d7f78b520d5599dcb39645cbc

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

Details for the file stellar_sdk-12.0.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for stellar_sdk-12.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 c8843e2bb0251f4b1de801c7ab7ba504fad11244e1eed7967e91acf16803ae7b
MD5 3b0c35905a556296e6b0666f2e0ccc14
BLAKE2b-256 8c1e42f7eabaa70d7e467b065314a79a1352ed900ca6ccda4d82cc1a365cc05a

See more details on using hashes here.

Provenance

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

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

Attestations:

Supported by

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