{"id":13425544,"url":"https://github.com/algorandfoundation/algokit-python-template","last_synced_at":"2026-05-02T08:11:38.112Z","repository":{"id":212705656,"uuid":"729187461","full_name":"algorandfoundation/algokit-python-template","owner":"algorandfoundation","description":"Official AlgoKit template for smart contract development project using Algorand Python","archived":false,"fork":false,"pushed_at":"2025-02-18T15:18:14.000Z","size":477,"stargazers_count":6,"open_issues_count":8,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-07T21:11:34.958Z","etag":null,"topics":["algokit","algokit-template","algorand","algorand-blockchain","algorand-smart-contract","python"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algorandfoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-08T16:02:58.000Z","updated_at":"2025-02-18T15:12:54.000Z","dependencies_parsed_at":"2023-12-22T17:21:32.609Z","dependency_job_id":"1a4846e4-8d8c-4cf1-abfc-bc824a743dd7","html_url":"https://github.com/algorandfoundation/algokit-python-template","commit_stats":null,"previous_names":["algorandfoundation/algokit-puya-template"],"tags_count":42,"template":true,"template_full_name":"algorandfoundation/algokit-beaker-default-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-python-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-python-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-python-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-python-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorandfoundation","download_url":"https://codeload.github.com/algorandfoundation/algokit-python-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243790919,"owners_count":20348377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algokit","algokit-template","algorand","algorand-blockchain","algorand-smart-contract","python"],"created_at":"2024-07-31T00:01:14.593Z","updated_at":"2026-05-02T08:11:38.097Z","avatar_url":"https://github.com/algorandfoundation.png","language":"Jinja","funding_links":[],"categories":["Core Resources","Development Tools"],"sub_categories":["AlgoKit Templates"],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://github.com/algorandfoundation/algokit-python-template\"\u003e\u003cimg src=\"./docs/images/banner.png\" width=60%\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca target=\"_blank\" href=\"https://github.com/algorandfoundation/algokit-cli\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-repository-00dc94?logo=github\u0026style=flat.svg\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://algorand.co/algokit/\"\u003e\u003cimg src=\"https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand\u0026mac=flat.svg\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://github.com/algorandfoundation/algokit-python-template\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/algorandfoundation/algokit-python-template?color=00dc94\u0026logo=star\u0026style=flat\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://algorand.co/algokit/\"\u003e\u003cimg  src=\"https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-python-template\u0026countColor=%2300dc94\u0026style=flat\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nThis template provides a production-ready baseline for developing and deploying [Puya](https://github.com/algorandfoundation/puya) smart contracts.\n\nTo 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.\n\nThis 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/).\n\n## Features\n\nThis template supports the following features:\n\n- 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\n- Deploy-time immutability and permanence control\n- [Poetry](https://python-poetry.org/) for Python dependency management and virtual environment management\n- Linting via [Ruff](https://github.com/charliermarsh/ruff) or [Flake8](https://flake8.pycqa.org/en/latest/)\n- Formatting via [Black](https://github.com/psf/black)\n- Type checking via [mypy](https://mypy-lang.org/)\n- Testing via pytest (not yet used)\n- Dependency vulnerability scanning via pip-audit (not yet used)\n- VS Code configuration (linting, formatting, breakpoint debugging)\n- dotenv (.env) file for configuration\n- Automated testing of the compiled smart contracts\n- [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output\n- CI/CD pipeline using GitHub Actions:\n- - Optionally pick deployments to Netlify or Vercel\n\n## Getting started\n\nOnce 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.\n\n### Interactive Wizard\n\n**To initialize using the `algokit` CLI**:\n\n- Execute the command `algokit init`. This initiates an interactive wizard that assists in selecting the most appropriate template for your project requirements.\n\n**To initialize within GitHub Codespaces**:\n\n- Follow these steps to leverage GitHub Codespaces for template selection:\n\n  1. Go to the [algokit-base-template](https://github.com/algorandfoundation/algokit-base-template) repository.\n  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.\n  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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Falgokit-python-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorandfoundation%2Falgokit-python-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Falgokit-python-template/lists"}