Migrating to a proper directory structure for python packages #95
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
Closed
…er-python-dir-structure
…er-python-dir-structure
b-per
approved these changes
Oct 5, 2024
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.
The existing repo structure does not align with best practices for python packages. This has several nasty implications:
lib/*/src, meaning that any other package that also uses thesrcdirectory could result in a namespace conflict or even overwriting of files (especiallymain.py).dbt-jobs-as-codethere are both relative references (.common_types) and references to modules in a manner that the end user will never use (src.client).To fix these issues this package should align with the practices recommended here ("src layout"), here and here.