SG-44795 Add PySide as a hard dependency - #83
Draft
julien-lang wants to merge 2 commits into
Draft
Conversation
tk-docs-preview requires PySide to be importable to build documentation for Toolkit repos. Previously PySide was only provided by tk-internal, so a direct install of tk-toolchain left it missing. Loose constraints are used intentionally - any working version suffices for doc generation, and callers such as tk-ci-tools control the exact version separately. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #83 +/- ##
=======================================
Coverage 48.95% 48.95%
=======================================
Files 19 19
Lines 721 721
=======================================
Hits 353 353
Misses 368 368
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
tk-docs-previewrequires PySide to be importable when building documentation for Toolkit repos, but PySide was never declared as a dependency insetup.py. A direct install oftk-toolchaintherefore fails immediately withERROR PySide2, or PySide6 are required to build the documentation.This PR adds PySide as a hard dependency using loose, unpinned constraints:
Loose constraints are intentional:
tk-docs-previewonly checks that PySide is importable — it does not call any PySide API, so any working version is sufficient. Callers such as CI pipelines or DCC environments that need a specific version can continue to control it via their own install step, which will take precedence.Test plan
pip install git+https://github.com/shotgunsoftware/tk-toolchain.git@ticket/SG-44795-add-pyside-dependencytk-docs-previewon a Toolkit repo and confirm documentation builds successfullyqt_wrappermatrix still controls the exact version used in tests)🤖 Generated with Claude Code