${escapeForMdx(trimmed)}
` + } + } + flushBullets() + + return `| Example | Description |
|---|
${meta.description}
+ ${count} examples +` + }) + .join('\n') + +fs.mkdirSync(OUTPUT_DIR, { recursive: true }) +fs.writeFileSync( + path.join(OUTPUT_DIR, 'index.mdx'), + `--- +title: Code Examples +description: "${totalCount} runnable Python examples demonstrating AlgoKit Utils features" +sidebar: + order: 0 +--- + +Browse **${totalCount}** runnable Python examples organized by feature area. Each example is self-contained and demonstrates specific functionality of the AlgoKit Utils library. + +## Quick Start + +\`\`\`bash +# Clone the repository +git clone https://github.com/algorandfoundation/algokit-utils-py.git +cd algokit-utils-py + +# Install dependencies +uv sync + +# Run any example +cd examples +uv run python algorand_client/01_client_instantiation.py +\`\`\` + +## Prerequisites + +- Python >= 3.10 +- [uv](https://docs.astral.sh/uv/) installed +- [AlgoKit CLI](https://github.com/algorandfoundation/algokit-cli) installed +- LocalNet running for network examples (\`algokit localnet start\`) + +*Some examples marked "No LocalNet required" work with pure utility functions.* + +## Categories + +| Resolve App by ID | +Resolve App by Creator and Name | +||
|---|---|---|---|
| Single App Client Instance | +Multiple App Client Instances | +Single App Client Instance | +Multiple App Client Instances | +
| + +```python +app_client = algorand.client.get_typed_app_client_by_id( + MyContractClient, + app_id=1234, + # ... +) +# or +app_client = MyContractClient( + algorand=algorand, + app_id=1234, + # ... +) +``` + + | ++ +```python +app_client1 = factory.get_app_client_by_id( + app_id=1234, + # ... +) +app_client2 = factory.get_app_client_by_id( + app_id=4321, + # ... +) +``` + + | ++ +```python +app_client = algorand.client.get_typed_app_client_by_creator_and_name( + MyContractClient, + creator_address="CREATORADDRESS", + app_name="contract-name", + # ... +) +# or +app_client = MyContractClient.from_creator_and_name( + algorand=algorand, + creator_address="CREATORADDRESS", + app_name="contract-name", + # ... +) +``` + + | ++ +```python +app_client1 = factory.get_app_client_by_creator_and_name( + creator_address="CREATORADDRESS", + app_name="contract-name", + # ... +) +app_client2 = factory.get_app_client_by_creator_and_name( + creator_address="CREATORADDRESS", + app_name="contract-name-2", + # ... +) +``` + + | +
| Deploy a New App | +Deploy or Resolve App Idempotently by Creator and Name | +
|---|---|
| + +```python +app_client, result = factory.send.bare.create( + # ... +) +# or +app_client, result = factory.send.create( + # method call params ... +) +``` + + | ++ +```python +app_client, result = factory.deploy( + app_name="contract-name", + # ... +) +``` + + | +