Refactor: Decompose cli.py into layered package structure#18
Open
n3rada wants to merge 10 commits intoRedByte1337:masterfrom
Open
Refactor: Decompose cli.py into layered package structure#18n3rada wants to merge 10 commits intoRedByte1337:masterfrom
cli.py into layered package structure#18n3rada wants to merge 10 commits intoRedByte1337:masterfrom
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
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.
Hello @RedByte1337 👋
As discussed, the fact that the application lived in a single huge
cli.pyfile mixing Flask routing, business logic, database access and so on, is really a thorn in the side for the project. Indeed, it makes you less inclined to dive in or suggest changes. And it means that each commit has to be on this single file.So, out of respect for the principles of maintainability and programming, I split the monolith into a proper layered package structure with strict separation of concerns:
cli.py: argparse and entrypoint only, now follows XDG Base Directory spec for data storage.app.py: Flask application factory.db/: isolated data layer.core/: pure business logic.api/: Flask blueprints.web/: page routes and static assets.All existing functionality is preserved. No schema changes. No API contract changes. Templates untouched.
The goal of this PR is to setup the project for future real changement (e.g., use of
msgraph-sdk, swaping thedb/layer with a proper ORM).Regards,