https://github.com/algorandfoundation/algokit-python-template
Official AlgoKit template for smart contract development project using Algorand Python
https://github.com/algorandfoundation/algokit-python-template
algokit algokit-template algorand algorand-blockchain algorand-smart-contract python
Last synced: about 2 months ago
JSON representation
Official AlgoKit template for smart contract development project using Algorand Python
- Host: GitHub
- URL: https://github.com/algorandfoundation/algokit-python-template
- Owner: algorandfoundation
- Created: 2023-12-08T16:02:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-18T15:18:14.000Z (3 months ago)
- Last Synced: 2025-03-07T21:11:34.958Z (2 months ago)
- Topics: algokit, algokit-template, algorand, algorand-blockchain, algorand-smart-contract, python
- Language: Jinja
- Homepage:
- Size: 466 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-algorand - algokit-python-template - Official AlgoKit's Algorand Python template provides a production-ready baseline for developing and deploying smart contracts in Python. (Core Resources / AlgoKit Templates)
- awesome-algorand - algokit-python-template - Official AlgoKit's Algorand Python template provides a production-ready baseline for developing and deploying smart contracts in Python. (Core Resources / AlgoKit Templates)
README
---
This template provides a production-ready baseline for developing and deploying [Puya](https://github.com/algorandfoundation/puya) smart contracts.
To use it [install AlgoKit](https://github.com/algorandfoundation/algokit-cli#readme) and then either pass in `-t python` to `algokit init` or select the `python` template.
This is one of the official templates used by AlgoKit to initialize an Algorand smart contract project. It's a [Copier template](https://copier.readthedocs.io/en/stable/).
## Features
This template supports the following features:
- Compilation of [multiple Puya contracts](template_content/smart_contracts/config.py) to a [predictable folder location and file layout](template_content/smart_contracts/__main__.py) where they can be deployed
- Deploy-time immutability and permanence control
- [Poetry](https://python-poetry.org/) for Python dependency management and virtual environment management
- Linting via [Ruff](https://github.com/charliermarsh/ruff) or [Flake8](https://flake8.pycqa.org/en/latest/)
- Formatting via [Black](https://github.com/psf/black)
- Type checking via [mypy](https://mypy-lang.org/)
- Testing via pytest (not yet used)
- Dependency vulnerability scanning via pip-audit (not yet used)
- VS Code configuration (linting, formatting, breakpoint debugging)
- dotenv (.env) file for configuration
- Automated testing of the compiled smart contracts
- [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output
- CI/CD pipeline using GitHub Actions:
- - Optionally pick deployments to Netlify or Vercel
## Getting started
Once the template is instantiated you can follow the [README.md](template_content/README.md.jinja) file to see instructions for how to use the template.
### Interactive Wizard
**To initialize using the `algokit` CLI**:
- Execute the command `algokit init`. This initiates an interactive wizard that assists in selecting the most appropriate template for your project requirements.
**To initialize within GitHub Codespaces**:
- Follow these steps to leverage GitHub Codespaces for template selection:
1. Go to the [algokit-base-template](https://github.com/algorandfoundation/algokit-base-template) repository.
2. Initiate a new codespace by selecting the `Create codespace on main` option. This can be found by clicking the `Code` button, then navigating to the `Codespaces` tab.
3. Upon codespace preparation, `algokit` will automatically start `LocalNet` and present a prompt with the next steps. Executing `algokit init` will initiate the interactive wizard.