Update template #2
Merged
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 pull request introduces several updates to the repository, focusing on CI workflow enhancements, documentation improvements, dependency management, and the addition of new code functionality. The most significant changes include adding new CI jobs for type checking and version consistency, updating the
README.mdto reflect these changes, modifyingpyproject.tomlto include new dependencies and configurations, and introducing a new function with its corresponding test.CI Workflow Enhancements:
.github/workflows/ci.yml: Added a newmypyjob for static type checking and aversion-checkjob to ensure version consistency between__init__.pyandpyproject.toml. Also updated thetestjob to include coverage report generation and artifact upload. [1] [2]Documentation Updates:
README.md: Added a section on type checking usingmypy, updated references to configuration files (e.g.,pyproject.tomlfor linting), and removed mentions oftestdependencies, focusing solely ondevdependencies. [1] [2] [3] [4]Dependency and Configuration Changes:
pyproject.toml: Updated the project version to0.1.0, added new dependencies (mypy,tomli), enhancedpytestoptions, and introducedmypyconfigurations for stricter type checking. Adjustedrufflinting rules and exclusions. [1] [2] [3] [4] [5]New Code Functionality:
src/example/__init__.py: Added__version__to define the project version programmatically.src/example/main.py: Introduced a new functionexample_functionthat returns a sample string.tests/example/test_main.py: Added a test forexample_functionto validate its behavior.Test Cleanup:
tests/test_script.py: Removed an unused test suite to streamline the test structure.