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.7+ as well as PyPy 3.7+.

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 --pre stellar-sdk

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

pip install --upgrade --pre 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-9.0.0b0.tar.gz (282.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stellar_sdk-9.0.0b0-py3-none-any.whl (681.8 kB view details)

Uploaded Python 3

File details

Details for the file stellar_sdk-9.0.0b0.tar.gz.

File metadata

  • Download URL: stellar_sdk-9.0.0b0.tar.gz
  • Upload date:
  • Size: 282.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for stellar_sdk-9.0.0b0.tar.gz
Algorithm Hash digest
SHA256 fbe5ece15c4203588ef0fa4fdb46684f1a8440b9d0aaa1ab5b860949805d5d95
MD5 f2490f80a7ba0560d467c9f7ff1f6b76
BLAKE2b-256 3221643a48c693196f7f3686abce50c1fd3245e10e8d6797900bcfacec7504fc

See more details on using hashes here.

File details

Details for the file stellar_sdk-9.0.0b0-py3-none-any.whl.

File metadata

  • Download URL: stellar_sdk-9.0.0b0-py3-none-any.whl
  • Upload date:
  • Size: 681.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for stellar_sdk-9.0.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a6e20a64376abcf89a431fd28adb047acdb00240f89d3e2b8ba16ca553f05ca
MD5 fbca9ef26ac6d67ec7739566e500bd43
BLAKE2b-256 8559f2fbb179c2c4b2ce71d6ffa445e674a798de04109b75f74931ac940d2918

See more details on using hashes here.

Supported by

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