Merge pull request #27 from satyam-seth-learnings/v2

v2

Author: satyam-seth

.env

@@ -0,0 +1 @@
+MANAGE_PY_PATH=manage.py

.githooks/pre-push

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+echo "Running tests with coverage..."
+
+coverage run manage.py test
+status=$?
+
+if [ $status -ne 0 ]; then
+  echo "❌ Tests failed. Push aborted."
+  exit 1
+fi
+
+coverage report --fail-under=85  # set your threshold
+if [ $? -ne 0 ]; then
+  echo "❌ Coverage is below threshold. Push aborted."
+  exit 1
+fi
+
+echo "✅ Tests passed and coverage is acceptable. Proceeding with push."

.github/workflows/basic-checks.yaml

@@ -0,0 +1,42 @@
+name: 🚦 Basic Checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  quality-checks:
+    name: Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: 📦 Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: 🎨 Run black (formatting)
+        run: black --check .
+
+      - name: 🧹 Run isort (import sorting)
+        run: isort --check-only .
+
+      - name: 🧐 Run mypy (type checking)
+        run: mypy .
+
+      - name: 🔍 Run pylint (linting)
+        run: pylint **/*.py
+
+      - name: 🧪 Run tests with coverage
+        run: coverage run manage.py test
+
+      - name: 📊 Generate coverage report (fail if <85%)
+        run: coverage report --fail-under=85

.gitignore

@@ -1,2 +1,5 @@
 .venv
-__pycache__
+__pycache__/
+*sqlite3
+.coverage
+htmlcov

.isort.cfg

@@ -0,0 +1,52 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        name: black to format python code
+
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        name: isort to sort imports
+        args:
+          - --profile
+          - black
+          - --verbose
+          - --skip-glob
+          - "**/migrations/*.py"
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.0
+    hooks:
+      - id: mypy
+        name: mypy to check types
+        additional_dependencies:
+          - django-jazzmin==3.0.1
+          - django-stubs==5.2.2
+          - djangorestframework==3.16.0
+          - djangorestframework-stubs==3.16.1
+        args: ["--config-file=mypy.ini"]
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v3.3.7
+    hooks:
+      - id: pylint
+        name: pylint to check code quality
+        entry: pylint
+        language: python
+        types: [python]
+        args: ["--rcfile=.pylintrc"]
+        additional_dependencies:
+          - django-jazzmin==3.0.1
+          - Django==5.2.4
+          - pylint-django==2.6.1
+          - djangorestframework==3.16.0

.pre-commit-config.yaml

@@ -5,6 +5,10 @@
 # only in one or another interpreter, leading to false positives when analysed.
 analyse-fallback-blocks=no
 
+# Clear in-memory caches upon conclusion of linting. Useful if running pylint
+# in a server-like mode.
+clear-cache-post-run=no
+
 # Load and enable all available extensions. Use --list-extensions to see a list
 # all available extensions.
 #enable-all-extensions=
@@ -46,9 +50,9 @@ ignore=CVS
 
 # Add files or directories matching the regular expressions patterns to the
 # ignore-list. The regex matches against paths and can be in Posix or Windows
-# format. Because '\' represents the directory delimiter on Windows systems, it
-# can't be used as an escape character.
-ignore-paths=
+# format. Because '\\' represents the directory delimiter on Windows systems,
+# it can't be used as an escape character.
+ignore-paths=.*/migrations
 
 # Files or directories matching the regular expression patterns are skipped.
 # The regex matches against base names, not paths. The default value ignores
@@ -89,6 +93,12 @@ py-version=3.10
 # Discover python modules and packages in the file system subtree.
 recursive=no
 
+# Add paths to the list of the source roots. Supports globbing patterns. The
+# source root is an absolute path or a path relative to the current working
+# directory used to determine a package namespace for modules located under the
+# source root.
+source-roots=
+
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
 suggestion-mode=yes
@@ -224,6 +234,10 @@ no-docstring-rgx=^_
 # These decorators are taken in consideration only for invalid-name.
 property-classes=abc.abstractproperty
 
+# Regular expression matching correct type alias names. If left empty, type
+# alias names will be checked with the set naming style.
+#typealias-rgx=
+
 # Regular expression matching correct type variable names. If left empty, type
 # variable names will be checked with the set naming style.
 #typevar-rgx=
@@ -246,21 +260,18 @@ check-protected-access-in-special-methods=no
 defining-attr-methods=__init__,
                       __new__,
                       setUp,
+                      asyncSetUp,
                       __post_init__
 
 # List of member names, which should be excluded from the protected access
 # warning.
-exclude-protected=_asdict,
-                  _fields,
-                  _replace,
-                  _source,
-                  _make
+exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
 
 # List of valid names for the first argument in a class method.
 valid-classmethod-first-arg=cls
 
 # List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=cls
+valid-metaclass-classmethod-first-arg=mcs
 
 
 [DESIGN]
@@ -307,8 +318,7 @@ min-public-methods=2
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when caught.
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,builtins.Exception
 
 
 [FORMAT]
@@ -347,6 +357,9 @@ single-line-if-stmt=no
 # one.
 allow-any-import-level=
 
+# Allow explicit reexports by alias from a package __init__.
+allow-reexport-from-package=no
+
 # Allow wildcard imports from modules that define __all__.
 allow-wildcard-with-all=no
 
@@ -416,14 +429,18 @@ disable=raw-checker-failed,
         useless-suppression,
         deprecated-pragma,
         use-symbolic-message-instead,
-        import-outside-toplevel
-        
+        use-implicit-booleaness-not-comparison-to-string,
+        use-implicit-booleaness-not-comparison-to-zero,
+        missing-module-docstring,
+        import-outside-toplevel,
+        fixme
+
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once). See also the "--disable" option for examples.
-enable=c-extension-no-member
+enable=
 
 
 [METHOD_ARGS]
@@ -469,8 +486,9 @@ evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor
 # used to format the message information. See doc for all details.
 msg-template=
 
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio). You can also give a reporter class, e.g.
+# Set the output format. Available formats are: text, parseable, colorized,
+# json2 (improved json format), json (old json format) and msvs (visual
+# studio). You can also give a reporter class, e.g.
 # mypackage.mymodule.MyReporterClass.
 #output-format=
 
@@ -504,8 +522,8 @@ min-similarity-lines=4
 # Limits count of emitted suggestions for spelling mistakes.
 max-spelling-suggestions=4
 
-# Spelling dictionary name. Available dictionaries: none. To make it work,
-# install the 'python-enchant' package.
+# Spelling dictionary name. No available dictionaries : You need to install
+# both the python package and the system dependency for enchant to work.
 spelling-dict=
 
 # List of comma separated words that should be considered directives if they
@@ -622,4 +640,4 @@ redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
 
 # pylint_django configuration
 [pylint-django]
-django-settings-module=django_starter.settings
+django-settings-module=backend.settings

.pylintrc

@@ -0,0 +1,15 @@
+{
+  "recommendations": [
+    "ms-python.python",
+    "esbenp.prettier-vscode",
+    "ms-python.black-formatter",
+    "ms-python.isort",
+    "ms-python.mypy-type-checker",
+    "batisteo.vscode-django",
+    "ms-python.pylint",
+    "ms-python.debugpy",
+    "ms-python.vscode-pylance",
+    "yy0931.vscode-sqlite3-editor",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

.vscode/extensions.json

@@ -1,22 +1,19 @@
 {
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-        "source.fixAll": true,
-        "source.organizeImports": true,
-    },
-    "isort.args": [
-        "skip_glob",
-        "*/migrations/*",
-    ],
-    "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter"
-    },
-    "python.linting.enabled": true,
-    "python.linting.pylintEnabled": true,
-    "python.linting.pylintArgs": [
-        "--load-plugins",
-        "pylint_django",
-        "django-settings-module=django_starter.settings",
-    ],
-    "python.linting.mypyEnabled": true,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "source.unusedImports": "explicit",
+    "source.organizeImports": "explicit"
+  },
+  "editor.rulers": [100],
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter"
+  },
+  "isort.args": ["--profile", "black", "--skip-glob", "*/migrations/*"],
+  "python.testing.unittestEnabled": true,
+  "python.testing.pytestEnabled": false,
+  "python.testing.unittestArgs": ["-p", "*test*.py"]
 }