Refactor directory structure and unify frontend and backend #21
Conversation
This file contains 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
- Remove backend/frontend directories and move files under src - Rename frontend directory to static (convention for Flask) - Update import paths and references accordingly - Rename main.py to cli.py to avoid naming conflicts - Allow Flask app to accept requests from all network interfaces(0.0.0.0)
- Modify test directory structure to match the updated source directory - Update import paths and references in test files - Adjust pytest.yaml configuration to reflect the new directory structure
Open
K-dash
commented
May 28, 2024
ryansurf
reviewed
May 28, 2024
ryansurf
approved these changes
May 28, 2024
There was a problem hiding this comment.
Looks like you cleaned up the code, very nice. Are you using Pylint?
There was a problem hiding this comment.
@ryansurf
I ran the code through the Black formatter.
By the way, since there is currently no linter implemented, how about using ruff? Ruff not only has a linter function but also a formatter function, so you can unify everything under ruff and eliminate Black :)
There was a problem hiding this comment.
Ah, forgot about the black formatter 😂
Two birds one stone! Sounds like a good plan to me, lets do it
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.
@ryansurf
This PR addresses the directory structure changes discussed in #19 (comment).
The modifications turned out to be more extensive than initially anticipated. Please refer to the commit messages for the specific changes made.
65ea49e
e7acc8f
136f2e0
60001d6
I have also thoroughly verified that the application runs without issues using Docker and that the frontend functionality works as expected.
Once this PR is merged, I can start working on creating the unit test files!
Please review the changes and provide any feedback or suggestions.
Please feel free to ask if you have any questions or uncertainties.
Most significant change
The
main.pyfile has been renamed tocli.py.The reason for changing
main.pytocli.pywas to resolve the naming conflict between the module name and the function name when importing themainfunction intest_code.py.Initially, the
main.pyfile contained a function namedmain. In thetest_code.pyfile, the main function was imported usingfrom src.main import main.However, this approach resulted in importing the main module instead of directly calling the main function. The error message
TypeError: 'module' object is not callable was encountered.To resolve this issue, two changes were made:
main.pyfile was renamed tocli.py. This avoids the naming conflict between the module and the function.cli.pywas renamed torun. This allowstest_code.pyto import therunfunction usingfrom src.cli import run.These changes resolved the naming conflict between the module and the function, enabling the test code to execute successfully.
Additionally, renaming
main.pytocli.pyprovides a clearer indication of the file's role and purpose within the project.Fixes #20