Modernize packaging #78
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
The setup.cfg file has been removed and its functionality migrated to the pyproject.toml file. This aligns with the move towards PEP 518 compliance, providing a more standardized and simplified project configuration. Importantly, setup.cfg's metadata and options have been incorporated into pyproject.toml's [project] and [tool.*] sections.
Hatch is now being used for package management in the project. Various files including 'docs/index.rst', 'envs/environment-dev.yaml', 'pyproject.toml', and 'README.rst' have been updated to include the necessary usage and references for Hatch. This commit also implements changes in build system requirements and target wheel inclusion.
Move the version identifier from __init__.py a new __about__.py file. The version is now dynamically read from that file to maintain the consistency of version info.
More robust, consistent, and modern.
Necessary so that Sphinx can access the package metadata.
douglatornell
added
documentation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #78 +/- ##
==========================================
- Coverage 74.83% 74.72% -0.12%
==========================================
Files 14 15 +1
Lines 906 906
Branches 161 161
==========================================
- Hits 678 677 -1
- Misses 221 222 +1
Partials 7 7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
This commit introduces a comprehensive "Release Process" section in the documentation. It provides detailed steps on handling version bumps, creating annotations and tags for the release, and managing the associated GitHub milestones and issues.
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.
setup.cfgwith project metadata inpyproject.tomlsetuptoolstohatchling__about__.pyfileimportlib.metadata.version()to access version identifier