Exclude docs/ from wheel#17
Merged
Merged
Conversation
setuptools-scm's file finder includes all git-tracked files in the wheel, causing HA to flag an unexpected top-level docs/ directory. Setting include-package-data = false disables that auto-inclusion, and switching packages.find to an explicit allowlist ensures only the pymonoprice package is picked up. Co-Authored-By: Claude Sonnet 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
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.
What changed
setuptools-scm's file finder hooks into setuptools and includes all git-tracked files in the built wheel. This causeddocs/rs232-protocol.mdto appear as a top-leveldocs/directory in the wheel, which Home Assistant flags as unexpected.Fix
Two changes to
pyproject.toml:include-package-data = false— disables the setuptools-scm file finder from auto-including non-package filespackages.find.include = ["pymonoprice*"]— replaces the oldexclude = ["tests*"]with an explicit allowlist (safer and clearer)Verification
Built the wheel from a clean state and confirmed the contents are now only
pymonoprice/__init__.py,pymonoprice/py.typed, and dist-info metadata.docs/is gone.