API Reference¶
Welcome to the Algorithm Kit API reference. This page provides comprehensive documentation for all public APIs and modules.
Package Overview¶
Algorithm Kit is organized into logical modules for different types of algorithms and utilities.
Core Modules¶
algokit¶
The main package entry point.
import algokit
# Check version
print(algokit.__version__)
Development¶
This documentation is automatically generated from the source code. To contribute:
- Add proper docstrings to your functions and classes
- Use Google-style docstring format
- Include type hints for all parameters and return values
- Add examples in your docstrings
Building Documentation¶
To build the documentation locally:
# Install dependencies
uv pip install -e .[docs]
# Build docs
mkdocs build
# Serve docs locally
mkdocs serve
Contributing¶
See our Contributing Guide for detailed information on how to contribute to the project and documentation.