Reframe positioning: a PLC library first, REST publishing as a bonus#4
Merged
Conversation
Lead the READMEs and the PyPI summary with the user-facing value (talk to Mitsubishi PLCs over the MC protocol, handled by the bundled gomc-rest), and present REST exposure / connect() as a bonus. No code or dependency changes — positioning only, to make the package more approachable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SQbVkPEprK2ebcjck5ouUy
…aming
- Say 'MC protocol (3E/4E frames)' instead of equating it with SLMP. (P2)
- Diagram now says launch() returns a Server that provides a PLCClient, not a
PLCClient directly. (P2)
- Replace the vague 'REST publishing' wording with 'expose a REST API' /
'REST APIのネットワーク公開', and reword the Japanese intro to read as
technical prose ('MCプロトコル通信は同梱の gomc-rest サーバーが処理'). (P2)
- Match the PyPI summary wording.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SQbVkPEprK2ebcjck5ouUy
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
2 participants
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
Documentation/positioning only — no code or dependency changes. Leads with the user-facing value so the package is more approachable.
gomc-restfirst as a Python library to talk to Mitsubishi PLCs over the MC protocol (the protocol is handled by the bundled, auto-launched gomc-rest server).server_mode) and client mode (connect()) as a bonus, rather than the headline.Changes
README.md: reframe the intro and diagram caption.README_JP.md: reframe the intro only (keeps the rest of the existing rewrite intact).pyproject.toml: update the PyPI summary to match the new positioning.Notes
launch()/connect()/server_modeis unchanged.pyproject.tomlparses, the#access-controlanchor referenced from the intro exists, andimport gomc_reststill works.🤖 Generated with Claude Code
Generated by Claude Code