README.md

Sussex Job Similarity Tool

This repo provides the code used to create the SkillsMatcher tool developed in partnership with Sussex Chamber of Commerce.

The repo has two main attributes:

1. mcc_sussex/app.py: the code for the frontend of the Streamlit app
2. mcc_sussex/backend/*: all of the code for the data preprocessing and similarity calculations to evaluate job similarity using the algorithm described in this blog post

To run the app locally:

1. Clone this repo git clone https://github.com/nestauk/dap_ds_mcc_job_similarity_tool.git
2. Download the data with the pre-computed similarity calculations and place it within the mcc_sussex folder in the root directory
3. Install the project: from within the project folder run pip install -e .
4. Run the app: streamlit run mcc_sussex/app.py

To build a new app using the algorithm:

1. Download the data with the pre-computed similarity calculations
2. Leverage the utility functions in backend\recommendations to compare jobs