[FEATURE] Adds pre-commit hooks, Makefile recipe and Github action - AIL-162

Author: rodrigo-pessoa-lrn

.github/workflows/ci.yml

@@ -6,6 +6,23 @@ on:
   pull_request:
 
 jobs:
+  pre_commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Install Pre-commit Dependencies
+        run: pip install pre-commit
+
+      - name: Run Pre-commit Hooks
+        run: pre-commit run --all-files
+
   tests:
     runs-on: ubuntu-latest
     strategy:

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-json
+      - id: pretty-format-json
+        args: [ --autofix ]
+        exclude: frontend/package.*.json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: detect-private-key
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.26.8
+    hooks:
+      - id: typos

ChangeLog.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 - Deprecation warning for `datetime.utcnow()`
 
+### Added
+- Added pre-commit hooks and Github CI action for code formatting and linting.
+
 ## [v0.3.10] - 2024-10-16
 ### Security
 - Bump certifi minimum version to 2024.07.04
@@ -74,9 +77,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [v0.3.1] - 2019-08-07
 ### Fixed
-- Fixed an issue where the `DataApi` class's `results_iter` method would return no data 
+- Fixed an issue where the `DataApi` class's `results_iter` method would return no data
   when receiving responses from Data API endpoints that set the "`data`" field of the
-  response to an object (like the [itembank/questions endpoint](https://reference.learnosity.com/data-api/endpoints/itembank_endpoints#getQuestions) 
+  response to an object (like the [itembank/questions endpoint](https://reference.learnosity.com/data-api/endpoints/itembank_endpoints#getQuestions)
   when `item_references` is included in the request).
 
 ## [v0.3.0] - 2019-06-17

setup.py

@@ -13,6 +13,7 @@
 ]
 
 DEV_REQUIRES = [
+    'pre-commit',
     'setuptools',
     'twine',
     'wheel',