use poetry for dependency management

README.md

@@ -1,4 +1,4 @@
-[![Resume Matcher](Assets/img/header.png)](https://www.resumematcher.fyi)
+[![Resume Matcher](Assets/img/banner.png)](https://www.resumematcher.fyi)
 
 <div align="center">
 
@@ -19,6 +19,8 @@
 [![Resume Matcher](https://custom-icon-badges.demolab.com/badge/www.resumematcher.fyi-gold?style=flat-square&logo=globe&logoColor=black)](https://www.resumematcher.fyi)
 [![Resume Matcher](https://custom-icon-badges.demolab.com/badge/Live_Demo_on_Streamlit-green?style=flat-square&logo=live&color=F55353)](https://resume-matcher.streamlit.app/)
 
+[![Resume Matcher Docs](https://img.shields.io/badge/Checkout%20Resume%20Matcher%20Docs-%230288D1.svg?style=flat-square&logo=bookstack&logoColor=white&color=red)](https://github.com/srbhr/Resume-Matcher-Docs)
+
 <a href="https://www.producthunt.com/posts/resume-matcher?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-resume&#0045;matcher" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=401261&theme=light" alt="Resume&#0032;Matcher - Free&#0032;and&#0032;Open&#0045;Source&#0032;ATS&#0032;Tool&#0032;to&#0032;Match&#0032;Resumes&#0032;to&#0032;Job&#0032;Desc&#0046; | Product Hunt" style="width: 180px; height: 50px;" width="200" height="54"/></a>
 
 </div>
@@ -53,69 +55,105 @@ On top of that, there are various data visualizations that I've added to help yo
 
 Follow these steps to set up the environment and run the application.
 
-1. Fork the repository [here](https://github.com/srbhr/Resume-Matcher).
+1. Fork the repository [here](https://github.com/srbhr/Resume-Matcher/fork).
 
 2. Clone the forked repository.
 
-    ```bash
-    git clone https://github.com/<YOUR-USERNAME>/Resume-Matcher.git
-    cd Resume-Matcher
-    ```
+   ```bash
+   git clone https://github.com/<YOUR-USERNAME>/Resume-Matcher.git
+   cd Resume-Matcher
+   ```
 
 3. Create a Python Virtual Environment:
 
-    - Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
+   - Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
 
-        _Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
+     _Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
 
-        ```bash
-        virtualenv env
-        ```
+     ```bash
+     virtualenv env
+     ```
 
-    **OR**
+   **OR**
 
-    - Create a Python Virtual Environment:
+   - Create a Python Virtual Environment:
 
-        ```bash
-        python -m venv env
-        ```
+     ```bash
+     python -m venv env
+     ```
 
 4. Activate the Virtual Environment.
 
-    - On Windows.
-
-        ```bash
-        env\Scripts\activate
-        ```
-
-    - On macOS and Linux.
-
-        ```bash
-        source env/bin/activate
-        ```
+   - On Windows.
+
+     ```bash
+     env\Scripts\activate
+     ```
+
+   - On macOS and Linux.
+
+     ```bash
+     source env/bin/activate
+     ```
+
+    **OPTIONAL (For pyenv users)**
+
+   Run the application with pyenv (Refer this [article](https://realpython.com/intro-to-pyenv/#installing-pyenv))
+
+   - Build dependencies (on ubuntu)
+      ```
+      sudo apt-get install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev python openssl
+      ```
+      ```
+
+      sudo apt-get install build-essential zlib1g-dev libffi-dev libssl-dev libbz2-dev libreadline-dev libsqlite3-dev liblzma-dev libncurses-dev
+
+      sudo apt-get install python-tk python3-tk tk-dev
+
+      sudo apt-get install build-essential zlib1g-dev libffi-dev libssl-dev libbz2-dev libreadline-dev libsqlite3-dev liblzma-dev
+
+      ```
+   - pyenv installer
+     ```
+        curl https://pyenv.run | bash
+     ```
+   - Install desired python version
+     ```
+       pyenv install -v 3.11.0
+     ```
+
+   - pyenv with virtual enviroment 
+     ```
+        pyenv virtualenv 3.11.0 venv
+     ```
+
+   - Activate virtualenv with pyenv
+     ```
+        pyenv activate venv
+     ```
 
 5. Install Dependencies:
 
-    ```bash
-    pip install -r requirements.txt
-    ```
+   ```bash
+   pip install -r requirements.txt
+   ```
 
 6. Prepare Data:
 
-    - Resumes: Place your resumes in PDF format in the `Data/Resumes` folder. Remove any existing contents in this folder.
-    - Job Descriptions: Place your job descriptions in PDF format in the `Data/JobDescription` folder. Remove any existing contents in this folder.
+   - Resumes: Place your resumes in PDF format in the `Data/Resumes` folder. Remove any existing contents in this folder.
+   - Job Descriptions: Place your job descriptions in PDF format in the `Data/JobDescription` folder. Remove any existing contents in this folder.
 
 7. Parse Resumes to JSON:
 
-    ```python
-    python run_first.py
-    ```
+   ```python
+   python run_first.py
+   ```
 
 8. Run the Application:
 
-    ```python
-    streamlit run streamlit_app.py
-    ```
+   ```python
+   streamlit run streamlit_app.py
+   ```
 
 **Note**: For local versions, you do not need to run "streamlit_second.py" as it is specifically for deploying to Streamlit servers.
 
@@ -127,12 +165,31 @@ Follow these steps to set up the environment and run the application.
 
 1. Build the image and start application
 
-    ```bash
-        docker-compose up
-    ```
+   ```bash
+       docker-compose up
+   ```
 
 2. Open `localhost:80` on your browser
 
+### Cohere and Qdrant
+
+1.  Visit [Cohere website registration](https://dashboard.cohere.ai/welcome/register) and create an account.
+2.  Go to API keys and copy your cohere api key.
+3.  Visit [Qdrant website](https://cloud.qdrant.io/) and create an account.
+4.  Get your api key and cluster url.
+5.  Now create a yaml file named config.yml in Scripts/Similarity/ folder.
+6.  The format for the conifg file should be as below:
+    ```yaml
+    cohere:
+      api_key: cohere_key
+    qdrant:
+      api_key: qdrant_api_key
+      url: qdrant_cluster_url
+    ```
+7.  Please replace your values without any quotes.
+
+*Note: Please make sure that Qdrant_client's version is higher than v1.1*
+
 <br/>
 
 <div align="center">
@@ -153,6 +210,8 @@ Pull Requests & Issues are not just welcomed, they're celebrated! Let's create t
 
 🚀 Explore and improve our [Landing Page](https://github.com/srbhr/website-for-resume-matcher). PRs always welcome!
 
+📚 Contribute to the [Resume Matcher Docs](https://github.com/srbhr/Resume-Matcher-Docs) and help people get started with using the software. 
+
 #### Tech Stack
 
 Current:
@@ -161,7 +220,7 @@ Current:
 
 Upcoming:
 
-![](https://img.shields.io/badge/Python-14354C?style=flat-square&logo=python&logoColor=white) ![](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=flat-square&logo=tailwind-css&logoColor=white) ![](https://img.shields.io/badge/React-20232A?style=flat-square&logo=react&logoColor=61DAFB) ![](https://custom-icon-badges.demolab.com/badge/Fast_API-F11A7B?style=flat-square&logo=python&logoColor=22A699) ![](https://img.shields.io/badge/JavaScript-F7DF1E?style=flat-square&logo=javascript&logoColor=black) ![](https://img.shields.io/badge/HTML5-E34F26?style=flat-square&logo=html5&logoColor=white) ![](https://img.shields.io/badge/CSS3-1572B6?style=flat-square&logo=css3&logoColor=white)
+![Python](https://img.shields.io/badge/Python-FFD43B?style=flat-square&logo=python&logoColor=blue) ![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=flat-square&logo=tailwind-css&logoColor=white) ![Next JS](https://img.shields.io/badge/Next-black?style=flat-square&logo=next.js&logoColor=white) ![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=flat-square&logo=fastapi) ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white) ![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=flat-square&logo=html5&logoColor=white) ![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=flat-square&logo=css3&logoColor=white) ![& More](https://custom-icon-badges.demolab.com/badge/And_More-white?style=flat-square&logo=plus&logoColor=black)
 
 <br/>
 

build.dockerfile

@@ -8,4 +8,4 @@ RUN pip install -r requirements.txt
 RUN python run_first.py
 ENTRYPOINT [ "streamlit", "run", "streamlit_app.py"]
 
-EXPOSE 8501
+EXPOSE 8501