Fix template locations in site-packages - #79
Open
a-gardner1 wants to merge 6 commits into
Open
Conversation
…ates to manifest for pre-commit hooks
a-gardner1
marked this pull request as ready for review
October 9, 2023 22:15
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
1 participant
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.
As indicated in multiple open issues (#66, #74, #36), the package can have trouble locating the template files when globally installed in an environment. This can prevent one from using the package as a pre-commit hook.
This PR resolves the issue by restructuring
licenseheadersas an actual package and shifting the templates into its directory structure, which is then recursively included in the manifest. As part of testing the solution, I also updated the tests to use theunittestframework and fixed a minor bug in the Python template settings. Finally, in attempting to apply it to my own codebase, I made a slight change to the file reading that allowed it to progress in the event of aUnicodeDecodeError.I also shifted the setup logic to a more modern
pyproject.tomlformat, but I did not update the version.