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
Metadata
2 maintainers
Release files for pyteal 0.27.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pyteal-0.27.0.tar.gz | 254.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyteal-0.27.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 579.9 kB
Release files / pyteal-0.27.0.tar.gz
| Download URL | pyteal-0.27.0.tar.gz |
|---|---|
| Size | 254.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5630bc4587ed1304102ffba9c8f8a13344d2f3c161504ba2912a781533e48b1
|
|
BLAKE2b-256 checksum How to use checksums |
65c8b4160138428d24082e1a08b4e4f2f69153cf8ccd4c9a0261d7ff6a1faea1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / pyteal-0.27.0-py3-none-any.whl
| Download URL | pyteal-0.27.0-py3-none-any.whl |
|---|---|
| Size | 325.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d1fa79c6a7a94c82847b13d8f37e03158d0b05e6b361b936644b49d4d150d59e
|
|
BLAKE2b-256 checksum How to use checksums |
d45383beac9246e682f22d36bd0c80ab6ec142a680443d51313c302edb810d08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Security for pyteal 0.27.0
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.
