Skip to main content

Algorand Python

Algorand Python is a partial implementation of the Python programming language that runs on the AVM. It includes a statically typed framework for development of Algorand smart contracts and logic signatures, with Pythonic interfaces to underlying AVM functionality that works with standard Python tooling.

Algorand Python is compiled for execution on the AVM by PuyaPy, an optimising compiler that ensures the resulting AVM bytecode execution semantics that match the given Python code. PuyaPy produces output that is directly compatible with AlgoKit typed clients to make deployment and calling easy.

Documentation | Language guide

Installation

The easiest way to use Algorand Python is to instantiate a template with AlgoKit via:

algokit init -t python

This will give you a full development environment with intellisense, linting, automatic formatting, breakpoint debugging, deployment and CI/CD.

A sample smart contract will be placed under PROJECT_NAME/projects/PROJECT_NAME/smart_contracts/SMART_CONTRACT_NAME/contract.py (replacing PROJECT_NAME and SMART_CONTRACT_NAME with the values you chose during the template wizard.)

Manual Alternative

Alternatively, if you want to start from scratch you can do the following:

  1. Ensure you have Python 3.12+
  2. Install AlgoKit CLI
  3. Check you can run the compiler:
    algokit compile py -h
    
  4. Install Algorand Python into your project poetry add algorand-python
  5. Create a contract in a (e.g.) contract.py file:
    from algopy import ARC4Contract, arc4
    class HelloWorldContract(ARC4Contract):
        @arc4.abimethod
        def hello(self, name: arc4.String) -> arc4.String:
            return "Hello, " + name
    

Usage

  1. Navigate to your contract and compile it:
    algokit compile py contract.py
    
  2. You should now have HelloWorldContract.approval.teal and HelloWorldContract.clear.teal on the file system!
  3. We generally recommend using ARC-32 and generated typed clients to have the most optimal deployment and consumption experience; to do this you need to ask PuyaPy to output an ARC-32 compatible app spec file:
    algokit compile py contract.py --output-arc32 --no-output-teal
    
  4. You should now have HelloWorldContract.arc32.json, which can be generated into a client e.g. using AlgoKit CLI:
    algokit generate client HelloWorldContract.arc32.json --output client.py
    
  5. From here you can dive into the examples or look at the documentation.

Examples

There are many examples in this repo, here are some of the more useful ones that showcase what is possible.

The compiled output is available under the out/ directory alongside these, e.g. the approval TEAL for voting is available at examples/voting/out/VotingRoundApp.approval.teal.

Metadata

Release files for puyapy 2.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for puyapy 2.1.2
File Interpreter ABI Platform Actions
puyapy-2.1.2-py3-none-any.whl Python 3 none any Details for puyapy-2.1.2-py3-none-any.whl

Release files / puyapy-2.1.2-py3-none-any.whl

Download URL puyapy-2.1.2-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
33ea55aebf66cae8f3600ae8a48ec4449549ef8aa185581c6bbed13303f04a96
BLAKE2b-256 checksum
How to use checksums
2aec0ae580ad952b2a655a7a691430de7b90bf8ed2292d0175be5f5cb8149683
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for puyapy 2.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.1.2 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page