Developer Guide¶
Welcome to the Wurzel Developer Guide! This comprehensive guide covers everything you need to know to get started with Wurzel, from installation to building your own pipeline steps.
🚀 Quick Start¶
New to Wurzel? Follow this recommended path:
- Installation & Setup - Get Wurzel running on your system
- Getting Started - Learn the basics and development workflow
- Building Pipelines - Create your first pipeline
- Creating Custom Steps - Build your own processing components
- Data Contracts - Understand type-safe data exchange
📖 Documentation Structure¶
Installation & Environment¶
- Installation & Setup - Complete installation guide with Docker, dependencies, and troubleshooting
Development Workflow¶
- Getting Started - Development environment setup, testing, and code quality tools
Core Concepts¶
- Building Pipelines - How to define and structure pipelines
- Creating Custom Steps - Build your own data sources and processing steps
- Data Contracts - Type-safe data exchange between pipeline steps
🎯 Common Tasks¶
| Task | Documentation |
|---|---|
| Install Wurzel | Installation Guide |
| Set up development environment | Getting Started |
| Create a pipeline | Building Pipelines |
| Build a custom step | Creating Steps |
| Add a data source | Creating Steps |
| Run tests | Getting Started |
| Generate documentation | Getting Started |
🔗 External Resources¶
- Backend Documentation - Detailed guides for DVC and Argo Workflows backends
- Wurzel Project Documentation - Auto-generated API documentation
💡 Need Help?¶
- Check the troubleshooting section for common issues
- Review the examples for real-world usage patterns
- Consult the AI documentation for reference