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.
This pull request introduces significant updates to the project's GitHub Actions workflows, dependency management, and project structure. The changes streamline the CI/CD pipelines by adopting
poetryfor dependency management, enhance testing and documentation workflows, and refine versioning and metadata handling.GitHub Actions Workflow Updates:
.github/workflows/build_dist.yml: Addedpoetryfor dependency management, automated version bumping inpyproject.toml, and integrated tagging and release creation usinggithub-tag-action. [1] [2].github/workflows/docs.yml: Replaced directpipinstallations withpoetry, activated a virtual environment, and updated the documentation build process. [1] [2].github/workflows/tests.yml: Expanded branch triggers, replacedflake8withblackfor linting, addedmypyfor type checking, and introduced notebook testing withpytestandnbmake. [1] [2] [3]Dependency and Configuration Management:
pyproject.toml: Transitioned topoetryfor managing dependencies, grouped development and documentation dependencies, and updated versioning to useimportlib_metadata. [1] [2] [3]src/python_template/__init__.py: Dynamically set the package version usingimportlib_metadatainstead of hardcoding it.Documentation and Project Metadata:
README.md: Standardized directory and file descriptions with consistent formatting and updated section headers. [1] [2]These changes collectively modernize the project's infrastructure, improve maintainability, and ensure alignment with best practices.