Setuptools related improvements #1492
Merged
Conversation
This file contains 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
Only including `brian2` in the package list will not include sub-packages: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#package-discovery-and-namespace-packages
|
Hi @sanjayankur31 thanks for your PR! I have to say I am now more confused than ever – if I remember correctly, I only arrived at the current solution by trial and error, as you say, the documentation seems to suggest it shouldn't work. But then, our |
mstimberg
approved these changes
Nov 9, 2023
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.
I'm going to preface this PR by saying that I do not know why the current upstream configuration works. From what I see in the various docs, it shouldn't, but there's so much going on in the Python packaging ecosystem that I'm no longer confident I understand it all properly 😂
While building on Fedora, the current pyproject.toml etc., doesn't work---it only includes the top level brian2 package in the generated wheels. This seems to be the correct behaviour because as the setuptools documentation notes (or suggests rather), only including the top level package name in the package list is not enough. One either has to list all sub-packages, or use the discovery tools.
https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#package-discovery-and-namespace-packages
So, to ensure that all sub-packages and the necessary template/data is included, I had to tweak these files as noted in the PR. (the tests from my local build are still running, so there may be more data files that are needed to be added to the manifest etc.).