Getting Started#
🚧 Early Access Documentation
This documentation is part of an early access release and is under active development. Many sections are still being written, edited, or reorganized. Expect inconsistencies, missing content, outdated references, and broken cross-links.
We welcome feedback! If you find issues or have suggestions, please open an issue on our GitHub page.
Welcome to Osprey Framework! This comprehensive guide will take you from zero to building sophisticated intelligent agents, with working results at every step.
What You’ll Accomplish#
By following this comprehensive learning path, you’ll have:
A fully functional development environment
Your first working agent (weather assistant)
Production-grade control system patterns (control assistant)
Framework mastery through essential development patterns
Complete API reference for daily development
Prerequisites
Python 3.11 installed
Basic Python knowledge
Terminal/command line familiarity
Text editor or IDE
Your Learning Path#
Get your development environment running with Podman, dependencies, and configuration. Includes interactive CLI for easy project creation!
Outcome: Working dev environment
Build a mental model of how Osprey and its applications work, before diving into code.
Outcome: Prepared mind for your Osprey journey
Build a weather agent with natural language queries and mock API integration.
Outcome: Your first working agent
Production control system patterns with channel finding pipelines and comprehensive tooling.
Outcome: Enterprise integration patterns
See production applications like ALS Assistant for advanced patterns.
Outcome: Real-world inspiration
Master essential development patterns: capabilities, state management, and testing workflows.
Outcome: Framework expertise
Complete method documentation, parameters, and return values for daily development.
Outcome: Development reference