In 885 app stabilization linters (#85)

* Apply black, mypy, ruff, safety
* Add pyproject.toml
* Add test to verify non-configured DatabaseEngine
result in 'AttributeError' when using callable
* Add Make command to apply changes to resolve linting issues
* Add pre-commit hooks
* Add dependabot
* Rerun fresh install of dependencies


Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-885

.github/dependabot.yml

@@ -0,0 +1,28 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  # Maintain dependencies for application
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "MITLibraries/dataeng"
+
+  # Maintain dependencies for Docker
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "MITLibraries/dataeng"

.gitignore

@@ -13,4 +13,5 @@ tests/db/
 vendor/
 .env
 *.log
-output/
+output/
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+default_language_version:
+  python: python3.11 # set for project python version
+repos:
+  - repo: local
+    hooks:
+      - id: black-apply
+        name: black-apply
+        entry: pipenv run black
+        language: system
+        pass_filenames: true
+        types: ["python"]
+      - id: mypy
+        name: mypy
+        entry: pipenv run mypy
+        exclude: tests/
+        language: system
+        pass_filenames: true
+        types: ["python"]
+      - id: ruff-apply
+        name: ruff-apply
+        entry: pipenv run ruff check --fix
+        language: system
+        pass_filenames: true
+        types: ["python"]
+      - id: safety
+        name: safety
+        entry: pipenv check
+        language: system
+        pass_filenames: false

Makefile

@@ -18,6 +18,7 @@ DATETIME:=$(shell date -u +%Y%m%dT%H%M%SZ)
 
 install: # install python dependencies
 	pipenv install --dev
+	pipenv run pre-commit install
 
 update: install # update all python dependencies
 	pipenv clean
@@ -38,8 +39,30 @@ coveralls: test
 
 ## ---- Code quality and safety commands ---- ##
 
-lint: ## run linters
-	pipenv run flake8 carbon
+# linting commands
+lint: black mypy ruff safety 
+
+black:
+	pipenv run black --check --diff .
+
+mypy:
+	pipenv run mypy .
+
+ruff:
+	pipenv run ruff check .
+
+safety:
+	pipenv check
+	pipenv verify
+
+# apply changes to resolve any linting errors
+lint-apply: black-apply ruff-apply
+
+black-apply: 
+	pipenv run black .
+
+ruff-apply: 
+	pipenv run ruff check --fix .
 
 ## ---- Terraform-generated Developer Deploy Commands for Dev1 environment ---- ##
 

Pipfile

@@ -4,20 +4,28 @@ verify_ssl = true
 name = "pypi"
 
 [dev-packages]
+black = "*"
+boto3-stubs = {extras = ["essential"], version = "*"}
 coveralls = "*"
+lxml-stubs = "*"
+mypy = "*"
+pre-commit = "*"
 pytest = "*"
 pytest-cov = "*"
 PyYAML = "*"
 pyftpdlib = "*"
 pyopenssl = "*"
-flake8 = "*"
+ruff = "*"
+types-setuptools = "*"
+
 
 [packages]
+boto3 = "*"
 click = "*"
 lxml = "*"
-SQLAlchemy = "*"
 oracledb = "*"
-"boto3" = "*"
+SQLAlchemy = "*"
+
 sentry-sdk = "*"
 
 [requires]