feat: Comprehensive template modernization, infrastructure updates, and testing standardization#2
Merged
Merged
Conversation
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
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.
Description
This PR introduces a comprehensive modernization of the repository, bringing its infrastructure, testing suite, and documentation up to the latest standards. It incorporates
gitversionedfor automated versioning and updates the build system to utilizehatchanduvwith modern dependency management.Key changes include:
hatchanduvfor dependency management, adopting modernpyproject.tomlstandards anddependency-groups.__init__.py,__main__.py,logging.py,settings.py,compat.py) with strict typing, PEP-8 compliance, and OpenTelemetry compatibility.tests/directory into cleanly separatedunit,integration, ande2esuites. Implemented rigorous parameterized fixtures, removed redundant boilerplate, and ensured full public API test coverage.guides/directory, and standardized documentation withinsrc/using proper reST docstrings.gitversionedto handle dynamic project versioning automatically across all template derivatives.scripts/bootstrap.shutility to properly inject organization and project name placeholders for new downstream projects.Type of Change
README.md,SUPPORT.md, docstrings, etc.)Test Plan
Automated test suites (Unit, Integration, and E2E) have been overhauled and executed to ensure functional parity and strict quality standards:
hatch run test:unitto verify the internal logic of core modules without side effects.hatch run test:integrationto validate the functional pathways and configurations across modules.hatch run test:e2eto verify the CLI execution (python -m project_name) and end-to-end logging functionality.pre-commit run --all-filesandhatch run lint:checkto ensure no new warnings or type errors (MyPy) exist.hatch run docs:build.Related Issues
Screenshots / Visuals (if applicable)
N/A
Use of AI
## WRITTEN BY AI ##)Checklist
Important
Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of
project_name.project_name.