Remove backward compatibility aliases and update to standalone functions#31
Merged
Remove backward compatibility aliases and update to standalone functions#31
Conversation
…nctions - Remove CMD_* backward compatibility aliases from constants.py - Remove cli.py backward compatibility wrapper module - Update setup.cfg entry point to use nwp500.cli.__main__:run directly - Update all examples to use CommandCode enum instead of CMD_* aliases - Update examples to use standalone functions (build_tou_period, encode_price, decode_price, encode_week_bitfield, decode_week_bitfield) instead of NavienAPIClient.* static methods - Update documentation to reference standalone functions - Fix deprecated method name (set_dhw_operation_setting -> set_dhw_mode) - Remove broken relative links from README.rst - Add Read the Docs and GitHub links to README.rst header This is a maintenance release cleanup removing deprecated backward compatibility layers that are no longer needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This maintenance release cleanup removes deprecated backward compatibility layers:
Changes
Constants Module
CLI Module
nwp500.cli.__main__:rundirectlyEncoding Functions
build_tou_period()instead ofNavienAPIClient.build_tou_period()encode_price()/decode_price()instead ofNavienAPIClient.*encode_week_bitfield()/decode_week_bitfield()instead ofNavienAPIClient.*Documentation
Examples Fixed
Validation
CMD_*usage in codebaseNavienAPIClient.*static method usage in examples/docsBreaking Changes
None - all deprecated APIs were already replaced with new ones in previous releases. This just removes the old compatibility layers.