refactor: Make the project importable as a module #9
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
This PR introduces changes to make the project importable as a Python module and introduces more modern packaging standards. - Moved all project files into the `git_metrics` subfolder to create a proper Python module structure. - Updated the import statements in various modules to use explicit relative imports. - Introduced `pyproject.toml` file for PEP 517/518 standards, and added `setup.py` to ensure compatibility with both traditional and modern packaging tools. - Added entry points in `setup.py` for command-line scripts, making `calculate_four_metrics.py` and `git_metrics.py` accessible.
|
Background is: with these changes |
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.
This PR introduces changes to make the project importable as a Python module and introduces more modern packaging standards.
git_metricssubfolder to create a proper Python module structure.pyproject.tomlfile for PEP 517/518 standards, and addedsetup.pyto ensure compatibility with both traditional and modern packaging tools.setup.pyfor command-line scripts, makingcalculate_four_metrics.pyandgit_metrics.pyaccessible.