Promote Python SDK in sdks/python-sdk from POC to a complete and supported SDK#825
Merged
Haishi2016 merged 14 commits intoeclipse-symphony:mainfrom Jan 28, 2026
Merged
Conversation
- FEATURES.md to outline all available features of the SDK, including client features, authentication, target management, solution management, and more. - GLOSSARY.md to define key terms and concepts used within the SDK, enhancing understanding for new users. - QUICKSTART.md to provide a step-by-step guide for installation and basic usage, including examples for connecting to Symphony, working with targets, deploying solutions, and tracking deployment status.
- Introduced `models.py` containing data structures for Symphony SDK, including specifications for instances, components, and errors. - Added `summary.py` to provide Python translations of Symphony API summary models, including result specifications and summary generation. - Created `types.py` to define essential types and states used in the Symphony COA API, including error handling and constants.
…types and api-client
…etter - Initialized examples/README.md with detailed descriptions of new examples and usage instructions.
Haishi2016
reviewed
Jan 13, 2026
Contributor
Haishi2016
left a comment
Haishi2016
left a comment
There was a problem hiding this comment.
Great PR. Some comments are added.
… test commands with coverage options
Haishi2016
approved these changes
Jan 28, 2026
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.
As mentioned in #824:
This PR aims to promote the existing Python SDK under
sdks/python-sdkfrom a proof-of-concept to a structured, maintainable, and supported SDK.Summary of changes
This PR introduces the following improvements:
Converts the SDK to a proper Python package with a
pyproject.toml, explicit dependency definitions, and reproducible builds.Establishes a clear SDK structure with separated concerns for:
Non-goals
This PR intentionally does not attempt to:
Those concerns are deferred until the SDK is adopted and exercised by users.
Potential Follow-ups
ruffandmypywarnings/errorsNotes For Reviewers
pyproject.tomlas I couldn't quite choose if we use EPL 2.0 or MIT for Eclipse Symphony. (You'll see license headers in source code, I didn't remove them since they're coming from Muto Agent's repository). If someone enlightens me of the license requirements, I could update accordinglypython-sdk. It is still thereMuto Agent's repo. If PyPI package gets published, we'll migrate to that. @Haishi2016