Formatting: Initialize modules folders. - Githubissues

srbhr / Resume-Matcher

Resume Matcher is an open source, free tool to improve your resume. It works by using language models to compare and rank resumes with job descriptions.

https://www.resumematcher.fyi/

Apache License 2.0

4.72k stars 1.86k forks source link

Formatting: Initialize modules folders. #126

Closed ILB-96 closed 10 months ago

ILB-96 commented 10 months ago

Pull Request Title

Initialize Modules Folders

Related Issue

None

Description

Changed the way functions, classes and files are imported. Improves readability and reduces naming duplications.

Type

[ ] Bug Fix
[ ] Feature Enhancement
[ ] Documentation Update
[x] Code Refactoring
[ ] Other (please specify):

Proposed Changes

Created init.py in folders to initialize the folders as modules.
Importing for files with a single function or a single class can be done directly by importing the folder
No need to go all the way to the root folder everytime you import a module from your current folder or it's sub folders

Screenshots / Code Snippets (if applicable)

N/A

How to Test

no feature changes, the app is running as before without any unfound modules errors

Checklist

[x] The code compiles successfully without any errors or warnings
[x] The changes have been tested and verified
[x] The documentation has been updated (if applicable)
[x] The changes follow the project's coding guidelines and best practices
[x] The commit messages are descriptive and follow the project's guidelines
[x] All tests (if applicable) pass successfully
[x] This pull request has been linked to the related issue (if applicable)

Additional Information

Probably as the code and number of contributers grows you want to more strictly follow PEP8 guidelines and use the pre-commit library with a linter.