Move to src layout #23
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
Signed-off-by: Kai A. Hiller <[email protected]>
squahtx
suggested changes
Feb 16, 2022
IIRC that's |
squahtx
approved these changes
Feb 16, 2022
babolivier
added a commit
to matrix-org/python-canonicaljson
that referenced
this pull request
Sep 23, 2022
Package canonicaljson as a proper module rather than a single-file module. The main motivation is to expose the py.typed marker file so other projects can use the typing annotations. I've decided to go with an src/ layout for the module's source rather than the solution proposed in #50 (comment) to avoid a repeat of matrix-org/matrix-python-common#23. Fixes #50
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.
Moves the project to a src layout, which means that all regular modules reside inside the
srcfolder. For this project, this moves only thematrix_commonmodule.The most important aspect of this change is the
testsmodule now being separated from the regular modules. Separating the two types of modules allows them to be put (and not put!) on the Python path individually, which is not simply possible otherwise. This enables the use case of testing actually installed modules, which means running tests without mandatorily having the nearby modules overshadow the Python path.Closes #16.
(Should be the last nickpicky PR for a while)