ContextQMD
Back to Agno

Cookbook Python Style Guide

cookbook/STYLE_GUIDE.md

2.6.41.4 KB
Original Source

Cookbook Python Style Guide

This guide standardizes runnable cookbook .py examples.

Core Pattern

  1. Module docstring at the top:
  • What this example demonstrates
  • Key concepts
  • Prompts or inputs to try
  1. Sectioned flow using banner comments:
  • Config sections (storage, tools, knowledge, schemas) as needed
  • Instructions section
  • Create ... section
  • Run ... section
  • Optional More Examples section
  1. Main execution gate:
  • if __name__ == "__main__":
  • Keep runnable demo steps in this block
  1. No emoji characters in cookbook Python files.
python
"""
<Title>
<What this demonstrates>
"""

# ---------------------------------------------------------------------------
# <Config / Setup>
# ---------------------------------------------------------------------------

# ---------------------------------------------------------------------------
# Agent Instructions
# ---------------------------------------------------------------------------
instructions = """..."""

# ---------------------------------------------------------------------------
# Create the Agent
# ---------------------------------------------------------------------------
example_agent = Agent(...)

# ---------------------------------------------------------------------------
# Run the Agent
# ---------------------------------------------------------------------------
if __name__ == "__main__":
    example_agent.print_response("...", stream=True)