A python library for interacting with the Algorand network.

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

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

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.

Install dependencies

• pip3 install -r requirements.txt

Run tests

• make docker-test

Set up the Algorand Sandbox based test-harness without running the tests

• make harness

Format code:

• black .

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.")

Follow the instructions in Algorand's developer resources to install a node on your computer. You can also set up a local Algorand Sandbox with make harness.

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 for the Python SDK is available at py-algorand-sdk.readthedocs.io.

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