ci: Linter and formatter

.github/workflows/integration.yaml

@@ -0,0 +1,62 @@
+name: Integration
+
+on:
+  pull_request:
+    branches: ["dev"]
+
+jobs:
+  check-format: 
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11' 
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Check format
+        run: black --check .
+
+  check-linter:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11' 
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Check linter
+        run: ruff check .
+
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up docker environment
+        run: docker-compose up -d
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11' 
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Run tests
+        run: pytest
+        env:
+          PYTHONPATH: "."
+
+      - name: Clean docker environment
+        run: docker compose down --rmi all -v --remove-orphans

.gitignore

@@ -1,5 +1,12 @@
+# Python files
 venv
 __pycache__
+
+# Vscode files
+.vscode/*
+!.vscode/extensions.json
+
+# Pipelines files
 .coverage
 node_modules
 coverage.xml

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "ms-python.python",
+    "ms-python.black-formatter",
+    "charliermarsh.ruff", 
+    "usernamehw.errorlens"
+  ]
+}

README.md

@@ -60,8 +60,34 @@ docker compose up -d
 coverage run -m pytest
 ```
 
+### Formatting and linting
+
+If you installed the recommended extensions for VSCode, you may have the formatting and linting configured out of the box.
+
+Additionally, you may need to configure `black` to format `python` files with the following steps:
+
+- Open the command palette (Ctrl + Shift + P)
+- Search Format Document With...
+- Search Configure Default Formatter...
+- Select "Black Formatter"
+
+You can also run the following commands to format and lint the code from the console:
+
+```bash
+# Check format
+black --check .
+
+# Format all python files
+black .
+
+# Check lint
+ruff check .
+
+# Fix lint (if possible)
+ruff check --fix .
+```
+
 ## Coverage
 
 | [![circle](https://codecov.io/gh/hawks-atlanta/proxy-python/graphs/sunburst.svg?token=JODBEVCYCF)](https://app.codecov.io/gh/hawks-atlanta/proxy-python) | [![square](https://codecov.io/gh/hawks-atlanta/proxy-python/graphs/tree.svg?token=JODBEVCYCF)](https://app.codecov.io/gh/hawks-atlanta/proxy-python) |
-| ------------------------------------------------------------ | ------------------------------------------------------------ |
-
+| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |

pages/home/__init__.py

@@ -1,5 +1,6 @@
 import flask
-from ._view import *
+from ._view import view
+
 
 home = flask.Blueprint("home", __name__)
-home.register_blueprint(view)
+home.register_blueprint(view)

pages/home/_view.py

@@ -2,6 +2,7 @@
 
 view = flask.Blueprint("home", __name__)
 
+
 @view.route("/", methods=["GET"])
 def index():
-    return flask.render_template("index.html")
+    return flask.render_template("index.html")

pages/home/_view_test.py

@@ -1,5 +1,6 @@
 from main import app
 
+
 def test_view() -> None:
     response = app.test_client().get("/")
-    assert response.status_code == 200
+    assert response.status_code == 200

version.py

@@ -1,5 +1,5 @@
 import json
 
 with open("package.json", "rb") as pkg_file:
-	pkg = json.load(pkg_file)
-	print(f"version={pkg['version']}")
+    pkg = json.load(pkg_file)
+    print(f"version={pkg['version']}")