Recommend s7 as primary package in docs#667
Merged
Merged
Conversation
Update all documentation, examples, and source docstrings to present the s7 package as the recommended entry point for all PLC models, with snap7 kept for backwards compatibility. Add s7.util module re-exporting snap7.util so users never need to import snap7 directly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
s7as the primary package for all PLC models (S7-300/400/1200/1500), withsnap7kept for backwards compatibilitys7.utilmodule that re-exports allsnap7.utilhelpers, so users never need to importsnap7directlysnap7package to mark classes as legacy and point tos7equivalentss7.Clientdocs listed first,snap7.Clientdocs labeled as legacyChanges
s7.Client, legacy example shown separatelysnap7.util.*s7Test plan
-W(warnings-as-errors) — no errorsruff checkpasses on all changed filesmypypasses ons7/util.py🤖 Generated with Claude Code