PyTeal: Algorand Smart Contracts in Python
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.10.
If your operating system (OS) Python version < 3.10, we recommend:
- Rather than override the OS Python version, install Python >= 3.10 alongside the OS Python version.
- Use pyenv or similar tooling to manage multiple Python versions.
Recommended: Install from PyPi
Install the latest official release from PyPi:
pip install pyteal
Install Latest Commit
If needed, it's possible to install directly from the latest commit on master to use unreleased features:
WARNING: Unreleased code is experimental and may not be backwards compatible or function properly. Use extreme caution when installing PyTeal this way.
pip install git+https://github.com/algorand/pyteal
Documentation
- PyTeal Docs
docs/(README) contains raw docs.
Development Setup
Setup venv (one time):
python3 -m venv venv
Active venv:
. venv/bin/activate(if your shell is bash/zsh). venv/bin/activate.fish(if your shell is fish)
Pip install PyTeal in editable state with dependencies:
make setup-development- OR if you don't have
makeinstalled:pip install -e . && pip install -r requirements.txt
Format code:
black .
Lint using flake8:
flake8 docs examples pyteal scripts tests *.py
Type checking using mypy:
mypy pyteal scripts
Run unit tests:
pytest pyteal tests/unit
Run integration tests (assumes a developer-mode algod is available on port 4001):
pytest tests/integration
Stand up developer-mode algod on ports 4001, 4002 and tealdbg on port 9392 (assumes Docker is available on your system):
docker-compose up -d
Tear down and clean up resources for the developer-mode algod stood up above:
docker-compose down
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyteal-0.24.1.tar.gz.
File metadata
- Download URL: pyteal-0.24.1.tar.gz
- Upload date:
- Size: 247.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
172d796981f8f9d3a9a8fbe71a71a49cf185509780f46d82e29aaa692386d1fa
|
|
| MD5 |
5688ed234c602ee7b5780e0076af1c2b
|
|
| BLAKE2b-256 |
90f1c53cace18bb43f7141e9590f553b0cce1f2abe473be5e34ba1e54c38b157
|
File details
Details for the file pyteal-0.24.1-py3-none-any.whl.
File metadata
- Download URL: pyteal-0.24.1-py3-none-any.whl
- Upload date:
- Size: 313.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
19c601f0ea4d1a0be41a3fe48cd3807558a0e907cd47d0dca5df60977d78f2c4
|
|
| MD5 |
8c9805fef946ff0b769504705f82a46c
|
|
| BLAKE2b-256 |
28c341314a0abea4d4daf8d95aefce00369c403717b7d453c8cdfa3183eb09be
|
