| # Deprecations |
|
|
| ## Overview |
|
|
| This document tracks deprecated features and their removal schedule. |
|
|
| --- |
|
|
| ## Version 1.0.0 Deprecations |
|
|
| ### Legacy Animation API |
| **Deprecated:** v1.0.0 |
| **Will be removed:** v1.2.0 |
|
|
| Old way (deprecated): |
| ```python |
| from animations import OldSpinner |
| s = OldSpinner() |
| s.start() |
| ``` |
|
|
| New way (recommended): |
| ```python |
| from animations import Spinner |
| with Spinner("Loading..."): |
| do_something() |
| ``` |
|
|
| --- |
|
|
| ## Version 0.9.0 Deprecations |
|
|
| ### Python 3.7 Support |
| **Deprecated:** v0.9.0 |
| **Will be removed:** v2.0.0 |
|
|
| Python 3 support timeline: |
| - Python 3.7 - Deprecated in v0.9.0 |
| - Python 3.8 - Supported |
| - Python 3.9 - Supported |
| - Python 3.10 - Supported |
| - Python 3.11 - Supported |
| - Python 3.12 - Planned support |
|
|
| ### Legacy CLI format |
| **Deprecated:** v0.9.0 |
| **Will be removed:** v1.1.0 |
|
|
| Old CLI (deprecated): |
| ```bash |
| burme-coder run "question" |
| ``` |
|
|
| New CLI (recommended): |
| ```bash |
| burme-coder ask "question" |
| ``` |
|
|
| --- |
|
|
| ## Migration Guides |
|
|
| ### From v0.9.x to v1.0.0 |
|
|
| 1. **Update dependencies:** |
| ```bash |
| pip install --upgrade burme-coder-max |
| ``` |
|
|
| 2. **Update CLI commands:** |
| ```bash |
| # Old (deprecated) |
| burme-coder run "question" |
| |
| # New |
| burme-coder ask "question" |
| ``` |
|
|
| 3. **Update animation imports:** |
| ```python |
| # Old (deprecated) |
| from animations import OldSpinner |
| |
| # New |
| from animations import Spinner |
| ``` |
|
|
| --- |
|
|
| ## Removed Features |
|
|
| ### v1.0.0 |
| No features removed in v1.0.0 (initial release) |
|
|
| ### Planned Removals |
| | Feature | Version | Reason | |
| |---------|---------|--------| |
| | OldSpinner class | v1.2.0 | Improved API | |
| | Python 3.7 | v2.0.0 | Security | |
| | Legacy CLI | v1.1.0 | Clarity | |
|
|
| --- |
|
|
| ## Best Practices |
|
|
| 1. Always use recommended patterns |
| 2. Check deprecation warnings |
| 3. Update before major version changes |
| 4. Report issues if migration is difficult |
|
|
| ### Enable Deprecation Warnings |
| ```python |
| import warnings |
| warnings.filterwarnings('default', category=DeprecationWarning) |
| ``` |
|
|
| --- |
|
|
| ## Questions? |
|
|
| If you have questions about deprecations: |
| - 📧 Email: contact@amkyawdev.com |
| - 💬 GitHub Discussions |
|
|
| --- |
|
|
| *Last updated: January 2025* |
|
|