User Guides¶
In-depth guides and tutorials for Ezpl logging framework.
Overview¶
This section provides comprehensive guides for mastering Ezpl features and best practices.
Available Guides¶
| Guide | Description | Level |
|---|---|---|
| Development Guide | Development workflow and best practices | Intermediate |
| Testing Guide | Testing strategies and test suite documentation | Advanced |
| Configuration Guide | Advanced configuration management | Intermediate |
Quick Links¶
For Beginners¶
- Getting Started - Start here if you're new to Ezpl
- Basic Examples - Simple usage examples
For Developers¶
- Development Guide - Contributing and development workflow
- Testing Guide - Test suite and testing practices
For Advanced Users¶
- API Reference - Complete API documentation
- CLI Reference - Command-line interface
Topics¶
Core Concepts¶
- Singleton Pattern: Understanding Ezpl's singleton architecture
- Configuration Priority: How configuration sources are resolved
- Type System: Using type hints effectively with Ezpl
Features¶
- Console Logging: Rich-formatted console output with patterns
- File Logging: Structured file logging with rotation
- RichWizard: Advanced display capabilities
- Indentation: Contextual log indentation
- Progress Bars: Various progress indicators
Integration¶
- Application Integration: Integrating Ezpl into your applications
- Library Usage: Using Ezpl in libraries
- CLI Tools: Building CLI tools with Ezpl
Best Practices¶
- Performance: Optimizing logging performance
- Error Handling: Robust error handling strategies
- Testing: Testing applications that use Ezpl
- Production: Production deployment considerations
Coming Soon¶
Additional guides will be added:
- Performance Tuning - Optimizing Ezpl for high-performance applications
- Custom Handlers - Creating custom printer and logger handlers
- Integration Patterns - Common integration patterns and recipes
- Troubleshooting - Common issues and solutions
Contributing¶
Have a guide idea or want to contribute? See the Development Guide for contribution guidelines.
See Also¶
- Getting Started - Quick start guide
- API Reference - API documentation
- Examples - Practical examples
- CLI Reference - CLI documentation
Need Help?¶
- Issues: GitHub Issues
- Repository: https://github.com/neuraaak/ezplog