chore: Ignore examples directory for dist #6314#6315
Merged
Conversation
oz123
approved these changes
Dec 11, 2024
matteius
added a commit
that referenced
this pull request
Dec 15, 2025
Fixes #5937 The docs/ directory was being installed to site-packages root instead of being excluded from the package distribution. This could cause conflicts with other packages that have a docs/ directory (similar to the previously fixed examples/ directory issue in #6315). Added 'docs*' and 'docs.*' to the exclude pattern in [tool.setuptools.packages.find] to prevent the documentation files from being included in the wheel distribution.
matteius
added a commit
that referenced
this pull request
Dec 16, 2025
Fixes #5937 The docs/ directory was being installed to site-packages root instead of being excluded from the package distribution. This could cause conflicts with other packages that have a docs/ directory (similar to the previously fixed examples/ directory issue in #6315). Added 'docs*' and 'docs.*' to the exclude pattern in [tool.setuptools.packages.find] to prevent the documentation files from being included in the wheel distribution.
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.
fixes #6314
The issue
When you install pipenv you are getting the
examples/directory in this project which includes a Pipfile and it's lock file, and some security scanners will start reporting the packages declared in these as vulnerabilities (even thought the packages only get installed if youpipenv sync).The fix
Update the MANIFEST to exclude the examples directory
The checklist
news/directory to describe this fix with the extension.bugfix.rst,.feature.rst,.behavior.rst,.doc.rst..vendor.rst. or.trivial.rst(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.