Skip to main content

Algorand SDK in Python

Project description

py-algorand-sdk

Build Status PyPI version Documentation Status Code style: black

A python library for interacting with the Algorand network.

Installation

Run $ pip3 install py-algorand-sdk to install the package.

Alternatively, choose a distribution file, and run $ pip3 install [file name].

Supported Python versions

py-algorand-sdk's minimum Python version policy attempts to balance several constraints.

  • Make it easy for the community to use py-algorand-sdk by minimizing or excluding the need to customize Python installations.
  • Provide maintainers with access to newer language features that produce more robust software.

Given these constraints, the minimum Python version policy is: Target Python version on newest Ubuntu LTS released >= 6 months ago.

The rationale is:

  • If a major Linux OS distribution bumps a Python version, then it's sufficiently available to the community for us to upgrade.
  • The 6 month time buffer ensures we delay upgrades until the community starts using a recently released LTS version.

SDK Development

Install dependencies

  • pip3 install -r requirements.txt

Run tests

  • make docker-test

Format code:

  • black .

Quick start

Here's a simple example you can run without a node.

from algosdk import account, encoding

# generate an account
private_key, address = account.generate_account()
print("Private key:", private_key)
print("Address:", address)

# check if the address is valid
if encoding.is_valid_address(address):
    print("The address is valid!")
else:
    print("The address is invalid.")

Node setup

Follow the instructions in Algorand's developer resources to install a node on your computer.

Running examples/example.py

Before running example.py, start kmd on a private network or testnet node:

./goal kmd start -d [data directory]

Next, create a wallet and an account:

./goal wallet new [wallet name] -d [data directory]
./goal account new -d [data directory] -w [wallet name]

Visit the Algorand dispenser and enter the account address to fund your account.

Next, in tokens.py, either update the tokens and addresses, or provide a path to the data directory.

You're now ready to run example.py!

Documentation

Documentation for the Python SDK is available at py-algorand-sdk.readthedocs.io.

License

py-algorand-sdk is licensed under an MIT license. See the LICENSE file for details.

Project details


Download files

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

Source Distribution

py-algorand-sdk-1.13.1.tar.gz (134.4 kB view hashes)

Uploaded source

Built Distribution

py_algorand_sdk-1.13.1-py3-none-any.whl (159.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page