refactor: restructure project into a proper Python package layout (v2026.5.6)#73
Merged
Merged
Conversation
added 2 commits
May 6, 2026 17:52
- Package Restructuring - Code Cleanup - Import & Path Updates - Packaging & Distribution
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.
Summary
This PR overhauls the DockSec project structure, moving from a flat layout to a standard Python package structure. These changes make the codebase cleaner, more maintainable, and production-ready, aligning with industry standards for Python open-source projects.
Key Changes
docksec/package directory and moved all logic files (config.py,docker_scanner.py,utils.py, etc.) into it.docksec/cli.pyand updatedsetup.pyto point to the new location.main.pyand Windows metadata artifacts (*:Zone.Identifier) that were cluttering the repository.setup.py,MANIFEST.in, andpyproject.tomlto ensure proper distribution and inclusion of all package data.README.mdandCONTRIBUTING.mdto reflect the new structure and added aCHANGELOG.mdentry for this overhaul.Test Plan
python3 -m docksec.cli --helpworks correctly.pytest. All 17 unit and integration tests passed successfully after the restructuring.