Merge pull request microsoft#121 from microsoft/three-files-branch

Add linting configuration files

Author: UtkarshMishra-Microsoft

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+exclude = .venv, _pycache_, migrations
+ignore = E501,F401,F811,F841,E203,E231,W503

.github/workflows/pylint.yml

@@ -0,0 +1,35 @@
+name: Code Quality Workflow
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      # Step 1: Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Step 2: Set up Python environment
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Step 3: Run all code quality checks
+      - name: Run Code Quality Checks
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          echo "Fixing imports with Isort..."
+          python -m isort --verbose .
+          echo "Formatting code with Black..."
+          python -m black --verbose .
+          echo "Running Flake8..."
+          python -m flake8 --config=.flake8 --verbose .
+          echo "Running Pylint..."
+          python -m pylint --rcfile=.pylintrc --verbose .

.pylintrc

@@ -0,0 +1,24 @@
+[MASTER]
+ignore=__pycache__, migrations, .venv
+
+[MESSAGES CONTROL]
+
+disable=parse-error,missing-docstring,too-many-arguments,line-too-long
+
+[FORMAT]
+
+max-line-length=120
+
+[DESIGN]
+
+max-args=10
+max-locals=25
+max-branches=15
+max-statements=75
+
+[REPORTS]
+output-format=colorized
+reports=no
+
+[EXCEPTIONS]
+overgeneral-exceptions=builtins.Exception,builtins.BaseException

requirements.txt

@@ -10,3 +10,12 @@ uvicorn==0.24.0
 aiohttp==3.10.5
 gunicorn==20.1.0
 pydantic-settings==2.2.1
+# Development Tools
+pylint==2.17.5
+autopep8==2.0.2
+black==23.9.1
+isort==5.12.0
+flake8==6.0.0
+pyment==0.3.3
+charset-normalizer==3.3.0
+pycodestyle==2.10.0