fix(packaging): prevent unwanted files and tests from being installed#3911
Merged
DimitriPapadopoulos merged 1 commit intocodespell-project:mainfrom Apr 14, 2026
Merged
Conversation
Collaborator
|
What do you mean exactly by "installed as top-level packages"? I'm afraid I fail to understand which exact issue this PR solves. |
Collaborator
DimitriPapadopoulos
left a comment
DimitriPapadopoulos
left a comment
There was a problem hiding this comment.
Also, codespell_lib/tests should be removed from the wheel.
| "dist", | ||
| "snap", | ||
| "tools", | ||
| "example", |
Collaborator
There was a problem hiding this comment.
But then example is not currently included in the sdist or wheel. Why is that?
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
41b85ae to
92cb89f
Compare
mikelolasagasti
changed the title
Contributor
Author
|
I changed the approach:
|
Collaborator
|
Changes in wheels look good to me: As for sdists, would it be possible to get rid of the following items?
|
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
92cb89f to
1c9bf89
Compare
Contributor
Author
|
I've amended the commit to include the sdist cleanup. |
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
1c9bf89 to
8e44f6b
Compare
Collaborator
|
The contents of the sdist look rather good to me after the latest change to Perhaps add I believe the following files/directories are correctly ignored: |
Collaborator
|
As for the wheel, it looks perfect: |
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
8e44f6b to
077c6fb
Compare
Contributor
Author
|
Added |
Collaborator
|
I'm sorry, I wasn't clear at all. I meant including |
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
077c6fb to
32dd9c7
Compare
Contributor
Author
|
Yeah, now I understand what you meant. |
Collaborator
DimitriPapadopoulos
left a comment
DimitriPapadopoulos
left a comment
There was a problem hiding this comment.
Perhaps one last change for .pre-commit-config.yaml.
Refine package discovery and manifest exclusions to clean up both wheels and source distributions (sdists): - Dev-only paths like `tools/` and `example/` are not installed in wheels. - The `codespell_lib.tests` subpackage is excluded from the wheel. - Only files explicitly listed in `package-data` are bundled in wheels. - Dev metadata (.github, .devcontainer, .gitignore, .mailmap) is pruned from sdists. Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info>
mikelolasagasti
force-pushed
the
avoid-tools
branch
from
32dd9c7 to
25a3a81
Compare
DimitriPapadopoulos
approved these changes
Apr 14, 2026
Collaborator
|
Thank you @mikelolasagasti. |
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.
Disable implicit namespace discovery and exclude those dirs so dev-only paths like
tools/gen_OX.share not installed as top-level packages.