Dependencies, testing, and logging improvements#16
Merged
Conversation
added 2 commits
October 31, 2025 23:16
## feat: Dependencies, Testing, and Logging Improvements (Items #11-16) **Related to:** Items #11-16 from CODE_REVIEW_AND_IMPROVEMENTS.md ### Overview This PR completes Priority 1 improvements by adding dependency management, comprehensive test coverage, improved error handling, and structured logging. These changes enhance production readiness, maintainability, and developer experience. --- ### Dependencies & Configuration #### Item #11: Pin dependency versions in requirements.txt - **Problem**: No version pins - breaking changes in dependencies could break the tool unpredictably - **Solution**: - Pinned all dependencies with version constraints in both `requirements.txt` and `setup.py` - Used semantic versioning ranges (e.g., `pydantic>=2.0.0,<3.0.0`) - Added comments to organize dependency groups - **Files**: `requirements.txt`, `setup.py` - **Impact**: Prevents unexpected breaking changes from dependency updates **Example:** ```python # Before langchain pydantic # After pydantic>=2.0.0,<3.0.0 langchain-core>=0.3.0,<2.0.0 langchain>=0.3.0,<2.0.0 ``` #### Item #12: Fix Python version requirement mismatch - **Problem**: `setup.py` requires Python 3.12, but `pyproject.toml` targeted Python 3.8 - **Solution**: Aligned Python version requirements to 3.12 across all configuration files - **Files**: `setup.py`, `pyproject.toml` - **Impact**: Prevents installation confusion and ensures consistency **Changes:** - `setup.py`: `python_requires=">=3.12"` (already correct) - `pyproject.toml`: `target-version = ['py312']` (updated from `py38`) --- ### Error Handling & User Experience #### Item #13: Improved error handling for missing external tools - **Problem**: Tool checks existed but errors were not user-friendly - no installation guidance - **Solution**: - Added `_get_tool_installation_instructions()` method with platform-specific installation steps - Integrated installation instructions into error messages - Provides clear guidance for Docker, Trivy, and Hadolint on Linux, macOS, and Windows - **Files**: `docker_scanner.py` - **Impact**: Significantly improved user experience when tools are missing **Example Error Message (Before):**
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
1 participant
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 PR is adding dependency management, comprehensive test coverage, improved error handling, and structured logging. These changes enhance production readiness, maintainability, and developer experience.
requirements.txtandsetup.pypydantic>=2.0.0,<3.0.0)_get_tool_installation_instructions()method with platform-specific installation steps