Skip to content

Pcharlesme/pyteal

 
 

Repository files navigation

PyTeal logo

PyTeal: Algorand Smart Contracts in Python

Build Status PyPI version Documentation Status Code style: black

PyTeal is a Python language binding for Algorand Smart Contracts (ASC1s).

Algorand Smart Contracts are implemented using a new language that is stack-based, called Transaction Execution Approval Language (TEAL).

However, TEAL is essentially an assembly language. With PyTeal, developers can express smart contract logic purely using Python. PyTeal provides high level, functional programming style abstractions over TEAL and does type checking at construction time.

Install

PyTeal requires Python version >= 3.6

  • pip3 install pyteal

Documentation

PyTeal Docs

Run Demo

In PyTeal root directory:

  • jupyter notebook demo/Pyteal\ Demonstration.ipynb

Development Setup

Setup venv (one time):

  • python3 -m venv venv

Active venv:

  • . venv/bin/activate.fish (if your shell is fish)
  • . venv/bin/activate (if your shell is bash/zsh)

Pip install PyTeal in editable state

  • pip install -e .

Install dependencies:

  • pip3 install -r requirements.txt

Type checking using mypy:

  • mypy pyteal

Run tests:

  • pytest

Format code:

  • black .

About

Algorand Smart Contracts in Python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%