Added tools for dependency management and linting#16
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the project from a setuptools‑based configuration to Poetry, while adding tools for code quality including Ruff and mypy. It also updates development documentation and pre-commit hook configuration.
- Removed setup.py in favor of a pyproject.toml project file.
- Added configuration for dependency management (including dev and benchmarks groups), linting (Ruff), and static type checking (mypy).
- Updated README.md with detailed development setup and pre-commit hook instructions.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| setup.py | Removed in favor of Poetry-based dependency management |
| pyproject.toml | Added project metadata, dependencies, and configuration for Poetry, Ruff, and mypy |
| README.md | Added detailed development setup instructions for Poetry and pre-commit hooks |
| .pre-commit-config.yaml | Added pre-commit configuration for Ruff and mypy hooks |
|
|
||
|
|
||
| [tool.mypy] | ||
| python_version = "3.11" |
There was a problem hiding this comment.
The mypy configuration specifies '3.11', which may be inconsistent with the project's wider Python requirement of '>=3.10,<4.0'. Consider whether this setting might cause issues when running mypy in a Python 3.10 environment.
Suggested change
| python_version = "3.11" | |
| python_version = "3.10" |
Closed
Merged
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.
Overview
Added Poetry for dependency management and tools to ensure code quality, including:
Use the following command to install all dependencies:
Pre-commit hook
The above mentioned tools will run automatically on staged files during commit after installing pre-commit hooks by:
You can also run the pre-commit hook manually by: