Deprecate the Package #285
Conversation
There was a problem hiding this comment.
Pull request overview
This PR deprecates the cfa_azure package by adding deprecation warnings and notices across the codebase, directing users to migrate to cfa-cloudops instead. The version is bumped from 1.5.9 to 1.6.0.
- Added deprecation warning at package import level
- Added deprecation notice to the main client class initialization
- Updated README with deprecation banner and notice
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pyproject.toml | Bumped package version from 1.5.9 to 1.6.0 |
| cfa_azure/init.py | Added DeprecationWarning when package is imported |
| cfa_azure/clients.py | Added print statement warning about deprecation in client constructor |
| README.md | Added unmaintained badge and deprecation notice at top of file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cfa_azure/clients.py
Outdated
| print("*" * 60) | ||
| print( | ||
| "WARNING: The cfa_azure package is deprecated and will be removed in a future release. Please use cfa-cloudops instead." | ||
| ) | ||
| print("*" * 60) |
There was a problem hiding this comment.
Using print() for deprecation warnings is not the standard Python approach. Since a proper DeprecationWarning is already added in init.py, this print statement should be removed to avoid redundant warnings and follow Python conventions. If you want warnings in both places, use warnings.warn() here as well.
No description provided.