Examples Overview¶
Practical examples for each DSPU module.
Available Examples¶
Core Module¶
Learn about protocols, plugin registry, and exception handling.
- Basic protocol usage
- Plugin registration and retrieval
- Error handling patterns
Configuration¶
Multi-source configuration management.
- Loading from files (YAML, TOML, JSON, HOCON)
- Environment variable integration
- Vault secret integration
- Configuration watching
- Pydantic validation
I/O Operations¶
File operations and cloud storage.
- Basic file operations
- Multi-format file writing
- Path resolution and security
- Streaming large files
- Cloud storage (S3, GCS, Azure)
Async Utilities¶
Resilient async operations.
- Retry patterns with backoff strategies
- Rate limiting
- Circuit breakers
- Concurrency control
- Sync/async bridges
Validation¶
Data filtering and validation.
- Basic filters and composition
- Pydantic integration
- Real-world use cases
Security¶
Secret management and encryption.
- Secret management backends
- Authentication providers
- Encryption patterns
- Token rotation
Observability¶
Logging, tracing, and rich output.
- Basic logging setup
- Structured logging with context
- Tracing decorators
- Rich console output
- Progress bars
ML Utilities¶
Machine learning utilities.
- Complete ML pipeline
- Reproducibility and seed management
- Data splitting strategies
- Feature scaling and encoding
- Statistical analysis
- A/B testing
Running Examples¶
All examples are located in the examples/ directory:
# Clone the repository
git clone https://github.com/yourorg/dspu.git
cd dspu
# Install dependencies
uv sync --all-extras
# Run an example
python examples/ml/01_ml_pipeline.py
python examples/observability/01_basic_logging.py
Example Structure¶
Each module's examples directory contains:
README.md- Overview and documentation01_*.py- Basic usage examples02_*.py- Advanced patterns03_*.py- Real-world scenarios
Contributing Examples¶
Have a great use case? We welcome example contributions!
See the Contributing Guide for details.