Adding some lines of code

.github/ISSUE_TEMPLATE.md

@@ -9,7 +9,7 @@
 - [ ] Info
 - [ ] Bug
 - [ ] Documentation
-- [ ] Other (please specify): 
+- [ ] Other (please specify):
 
 ## Description
 <!-- Describe the issue in detail. What problem are you experiencing or what feature would you like to see added? -->
@@ -23,18 +23,18 @@
 
 ## Steps to Reproduce
 <!-- If applicable, provide a step-by-step guide to reproducing the issue -->
-1. 
-2. 
-3. 
+1.
+2.
+3.
 
 ## Screenshots / Code Snippets (if applicable)
 <!-- Include any relevant screenshots or code snippets that can help understand the issue better -->
 
 ## Environment
 <!-- Provide details about your environment -->
-- Operating System: 
-- Browser (if applicable): 
-- Version/Commit ID (if applicable): 
+- Operating System:
+- Browser (if applicable):
+- Version/Commit ID (if applicable):
 
 ## Possible Solution (if you have any in mind)
 <!-- If you have an idea about how to fix the issue, please share it here -->

.github/ISSUE_TEMPLATE/custom.md

@@ -6,5 +6,3 @@ labels: ''
 assignees: ''
 
 ---
-
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -29,4 +29,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] Any dependent changes have been merged and published in downstream modules

.github/workflows/changelog-ci.yml

@@ -0,0 +1,38 @@
+name: Changelog CI
+
+# Trigger on pull request event
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Check out the repository content
+      - uses: actions/checkout@v2
+
+      # Run Changelog CI action
+      - name: Run Changelog CI
+        uses: saadmk11/changelog-ci@v1.1.2
+        with:
+          changelog_filename: CHANGELOG.md
+          committer_username: github-actions[bot]
+          committer_email: github-actions[bot]@users.noreply.github.com
+          config_file: changelog-config.yaml
+          # GitHub token for authorization
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+        # Create a new release
+    #   - name: Create Release
+    #     id: create_release
+    #     uses: actions/create-release@v1
+    #     env:
+    #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    #     with:
+    #         tag_name: ${{ github.run_number }}
+    #         release_name: Release ${{ github.run_number }}
+    #         draft: false
+    #         prerelease: false

.github/workflows/python-app.yml

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Python application
 
 on:
@@ -14,32 +11,47 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+
     - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
+        # cache: "pip"
+    # - run: pip install -r requirements.txt
+
+    - name: Cache pip
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
     - name: Install dependencies
       run: |
+        python -m venv venv
+        source venv/bin/activate
         python -m pip install --upgrade pip
-        pip install flake8 pytest pytest-cov
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        pip install uv
+        uv pip install flake8 pytest pytest-cov
+        if [ -f requirements.txt ]; then uv pip install -r requirements.txt; fi
+
     - name: Test with pytest
       run: |
-        pytest --cov .
+        source venv/bin/activate
+        pytest --cov --cov-report term --cov-report xml:coverage.xml || true
       continue-on-error: true
+
     - name: Upload coverage reports to Codecov
       uses: codecov/codecov-action@v4.0.1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        slug: devansh-shah-11/FaceRec
+        slug: devansh-shah-11/FaceRec
+        files: coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        # fail_ci_if_error: true

.github/workflows/sonarcloud.yml

@@ -0,0 +1,58 @@
+name: SonarCloud analysis
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  security-events: write
+  pull-requests: read # allows SonarCloud to decorate PRs with analysis results
+
+jobs:
+  Analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Cache pip
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install uv
+          uv pip install flake8 pytest pytest-cov
+          if [ -f requirements.txt ]; then uv pip install -r requirements.txt; fi
+
+      - name: Test with pytest
+        run: |
+          source venv/bin/activate
+          pytest --cov --cov-report term --cov-report xml:coverage.xml || true
+        continue-on-error: true
+
+      - name: Upload coverage data to SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Provided by GitHub Actions, no need for custom PAT unless required
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}  # SonarCloud secret token
+        with:
+          args: >
+            -Dsonar.python.coverage.reportPaths=coverage.xml

.gitignore

@@ -139,4 +139,8 @@ cython_debug/
 venv/
 *.pyc
 .vscode/
-__pyc
+__pyc
+FaceRec/static/Images/uploads/*
+Images/dbImages/*
+Images/Faces/*
+Images/

.gitlab-ci.yml

@@ -0,0 +1,46 @@
+stages:
+  - build
+  - test
+
+default:
+  image: python:3.9.18-slim-bullseye
+
+cache:
+  paths:
+    - .cache/pip  # Cache pip downloads
+    - venv  # Cache virtual environment
+
+before_script:
+  - python -m venv venv  # Create a virtual environment
+  - source venv/bin/activate  # Activate virtual environment
+  - pip install --upgrade pip  # Upgrade pip
+  - pip install uv
+  - uv pip install -r requirements.txt  # Install requirements
+
+linting-job:
+  stage: build
+  script:
+    - echo "Linting code... This will take about 10 seconds."
+    - pip install black isort flake8  # Install additional linting tools
+    - black .
+    - isort .
+    - flake8 . || echo "Linting check failed but allowed to continue"
+
+pytest-job:
+  stage: build  # Change stage to 'build' to run in parallel with linting-job
+  script:
+    - echo "Running pytest... This will take about 1 minute."
+    - apt-get update && apt-get install ffmpeg libsm6 libxext6 -y
+    - uv pip install pytest-cov  # Install testing tools
+    - black .
+    - pytest --junitxml=pytest.xml || true  # Ensure that tests run to completion
+    - pytest --cov --cov-report term --cov-report xml:coverage.xml || true
+    - ls -la  # Debugging step to check if coverage.xml is present
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+      junit: pytest.xml
+    expire_in: "30 days"

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.8.0  # Use the latest stable version of Black
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/hhatto/autopep8
+    rev: v2.3.1  # Use the latest stable version of autopep8
+    hooks:
+      - id: autopep8

.pre-commit-security.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.0
+    hooks:
+      - id: bandit
+        files: \.py$  # Run Bandit only on Python files
+        additional_dependencies: [toml]  # Additional dependencies required by Bandit
+        args: [--skip, B101]  # Skip Bandit test B101 (assert statements)
+  - repo: https://github.com/safepass-dev/safepass-pre-commit
+    rev: v0.1.0
+    hooks:
+      - id: safepass
+        files: \.(py|yaml|yml|json)$  # Run Safepass on Python, YAML, and JSON files
+  - repo: https://github.com/pyupio/safety-hooks
+    rev: v2.0.3
+    hooks:
+      - id: safety

.readthedocs.yml

@@ -0,0 +1,19 @@
+# .readthedocs.yaml
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements.txt

API/_init_.py → API/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import uvicorn
 from fastapi import FastAPI