Documentation updates

.github/workflows/codecoverage.yml

@@ -8,29 +8,25 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: 3.8  # Replace '3.x' with your desired Python version
+          python-version: 3.10.12  # Replace '3.x' with your desired Python version
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pylint
-          pip install pandas
-          pip install -U Flask
-          pip install -U flask-cors
-          pip install pytest
-          pip install pytest-cov
+          pip install -r requirements.txt
 
       - name: Run tests and generate coverage
         run: |
-          cd test
-          coverage run --source=test -m pytest test_*.py
+          cd app
+          coverage run --source=test -m pytest test/test_*.py
           coverage xml -i
 
       - name: Upload coverage report to Codecov
-        run: |
-          bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/pylint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -17,10 +17,15 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
+        pip install -r requirements.txt
+        pip install flask
+        pip install flask_sqlalchemy
+        pip install flask_login
+        pip install flask_cors
         pip install pandas
-        pip install -U Flask
-        pip install -U flask-cors
+        pip install numpy
+        pip install pylint
     - name: Analysing the code with pylint
       run: |
-        pylint $(git ls-files '*.py')
+        cd app
+        pylint src

.github/workflows/unittest.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -17,14 +17,17 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
-        pip install pandas
-        pip install -U Flask
-        pip install -U flask-cors
+        pip install -r requirements.txt
     - name: Running test cases for predicting
-      run: python test/test_predict.py
+      run: |
+        cd app
+        python test/test_predict.py
     - name: Running test cases for searching
-      run: python test/test_search.py
+      run: |
+        cd app
+        python test/test_search.py
     - name: Running test cases for util
-      run: python test/test_util.py
+      run: |
+        cd app
+        python test/test_util.py
 

CONTRIBUTING.md

@@ -1,8 +1,6 @@
 ## Contributing:
 
-* If you would like to contribute and collaborate with this repository, then please inform us through email at popcornpicks504@gmail.com.
-
-## Purpose of Contributing:
+### Purpose of Contributing:
 
 * To develop our product and take it to the next level.
 * To enhance the already existing feature.
@@ -13,46 +11,46 @@
 * Help us to scale the system to a larger database
 * To run the email notifier feature - make your own Gmail account and password and replace the same in the utils.py(function: send_email_to_user(recipient_email, categorized_data))
 
-## Our Table Of Contents
-
-- .github/workflows  
-  - all GitHub workflow YAML files  
-- proj2  
-   - score_card.md  
-  
-- src  
-  - prediction_scripts    
-     - item_based.py   
-  - recommenderapp
-    - static
-      - script.js
-      - stylesheet.css
-    - templates
-      - landing_page.html
-      - search_page.html
-      - success.html
-    - app.py
-    - search.py
-    - utils.py
-  
-- test  
-    - test_predict.py  
-    - test_search.py  
-    - test_util.py  
-  
-- .gitignore
-
-- CODE_OF_CONDUCT.md
-
-- CONTRIBUTING.md
-
-- LICENSE
-
-- README.md
-
-- requirements.txt
-
-- setup.py
+### Our Table Of Contents
+```
+.
+├── app
+│   ├── init_db.py
+│   ├── instance
+│   │   └── site.db
+│   ├── run.py
+│   ├── src
+│   │   ├── __init__.py
+│   │   ├── item_based.py
+│   │   ├── models.py
+│   │   ├── __pycache__
+│   │   ├── routes.py
+│   │   ├── search.py
+│   │   ├── static
+│   │   ├── templates
+│   │   └── utils.py
+│   └── test
+│       ├── __init__.py
+│       ├── __pycache__
+│       ├── test_predict.py
+│       ├── test_search.py
+│       └── test_util.py
+├── asset
+│   ├── demo.gif
+│   ├── email.png
+│   ├── execution.gif
+│   ├── group12.png
+│   ├── header_display.png
+│   ├── system_architecture.svg
+│   └── SystemArch.png
+├── CODE_OF_CONDUCT.md
+├── CONTRIBUTING.md
+├── data
+│   └── movies.csv
+├── LICENSE
+├── README.md
+└── requirements.txt
+```
 
 ## Suggesting Enhancements
 
@@ -89,7 +87,7 @@ Any suggested enhancements like adding new features or improving existing functi
 
 ## Code of Conduct:
 
-* Please go through the [Code of Conduct](https://github.com/adipai/PopcornPicks/blob/master/CODE_OF_CONDUCT.md) before you begin contributing. This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to popcornpicks504@gmail.com.
+* Please go through the [Code of Conduct](https://github.com/tanmaypardeshi/PopcornPicks/blob/master/CODE_OF_CONDUCT.md) before you begin contributing. This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to popcornpicks504@gmail.com.
 
 ## Pull Request Submission Guidelines
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Aditya Pai, Ananya Mantravadi, Rishi Singhal, Samarth Shetty
+Copyright (c) 2023 Abhinav Sinha, Chandana Ray, Sam Kwiatkowski-Martin, Tanmay Pardeshi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -15,7 +15,7 @@ copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ORIGINAL AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR 
- OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, 
- ARISING FROM, OUT OF, OR IN CONNECTION WITH THE ORIGINAL SOFTWARE OR THE USE
-  OR OTHER DEALINGS IN THE ORIGINAL SOFTWARE OR THE NEW EXTENSIONS.
+ORIGINAL AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR 
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, 
+ARISING FROM, OUT OF, OR IN CONNECTION WITH THE ORIGINAL SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE ORIGINAL SOFTWARE OR THE NEW EXTENSIONS.