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.7k stars 1.84k forks source link

Add logging configuration and update similarity score display #245

Closed Devasy23 closed 3 months ago

Devasy23 commented 3 months ago

Pull Request Title

Enhancements and Improvements to Workspace Information Handling

Related Issue

N/A

Description

This pull request introduces several enhancements and improvements to the workspace information handling process. It includes updates to documentation, logger improvements, logging integration into the Streamlit app, and an alternative method for calculating similarity scores.

Type

Proposed Changes

Screenshots / Code Snippets (if applicable)

image

How to Test

  1. Pull the latest changes from this branch.
  2. Verify that documentation has been updated and is comprehensive.
  3. Ensure the logger.py file functions as expected in different scenarios.
  4. Test logging functionality in the Streamlit app by triggering various events.
  5. Verify the alternative similarity score calculation method in streamlit_interactive.py.

Checklist

Additional Information

These changes aim to improve the maintainability and functionality of the workspace information handling process. Feedback and further suggestions are welcomed.

Devasy23 commented 3 months ago

@srbhr you can see GPT4 enable code review on this commit here : https://github.com/Devasy23/Resume-Matcher/pull/2

Also, i need to commit after linting it with black and isort

srbhr commented 3 months ago

GPT-4 enabled code review ?

Devasy23 commented 3 months ago

GPT-4 enabled code review ?

yes, by github app called senior-dev

srbhr commented 3 months ago

@Devasy23 is this PR good to merge?

Devasy23 commented 3 months ago

@Devasy23 is this PR good to merge?

Yes it's good to merge but for extra surety just check it once.

The major changes are in utils.logger where I modularised the functions and also added docstrings, streamlit_interactive where I added the similarity score without api changes and added coloured rounded view of similarity score in streamlit_app.py

Everything else are formatting changes done by black and isort.

srbhr commented 3 months ago

Okay, so we have black as a formatter. This needs to go in the readme, which needs updating and a separate PR.