Update project configuration and linting defaults

Why these changes are being introduced:
* Simplify and harmonize project configuration and linting methods
with modern and active libraries that augment one another.

How this addresses that need:
* Replace setup.cfg with pyproject.toml
* Use updated pyproject.toml template
* Use updated Makefile template
* Add pre-commit hooks
* Update various modules to address Ruff's lint rules
* Update Pipfile to remove deprecated dev packages
* Update Python version to 3.11

Side effects of this change:
* Updated dependencies and deprecation of setup.cfg

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

Author: jonavellecuerdo

.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
+        language: system
+        pass_filenames: true
+        types: ["python"]
+        exclude: "tests/"
+      - 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

.python-version

@@ -1 +1 @@
-3.10.3
+3.11.4

Makefile

@@ -1,40 +1,49 @@
 SHELL=/bin/bash
 DATETIME:=$(shell date -u +%Y%m%dT%H%M%SZ)
 
-### Dependency commands ###
+## ---- Dependency commands ---- ##
 
-install: ## Install dependencies and CLI app
+install: # install dependencies
 	pipenv install --dev
+	pipenv run pre-commit install
 
-update: install ## Update all Python dependencies
+update: install # update all Python dependencies
 	pipenv clean
 	pipenv update --dev
 
-### Test commands ###
+## ---- Unit test commands ---- ##
 
-test: ## Run tests and print a coverage report
+test: # run tests and print a coverage report
 	pipenv run coverage run --source=my_app -m pytest -vv
 	pipenv run coverage report -m
 
 coveralls: test
 	pipenv run coverage lcov -o ./coverage/lcov.info
 
-### Code quality and safety commands ###
 
-lint: bandit black mypy pylama safety ## Run linting, code quality, and safety checks
+## ---- Code quality and safety commands ---- ##
 
-bandit:
-	pipenv run bandit -r my_app
+# linting commands
+lint: black mypy ruff safety 
 
 black:
 	pipenv run black --check --diff .
 
 mypy:
-	pipenv run mypy my_app
+	pipenv run mypy .
 
-pylama:
-	pipenv run pylama --options setup.cfg
+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 .

Pipfile

@@ -8,16 +8,15 @@ click = "*"
 sentry-sdk = "*"
 
 [dev-packages]
-bandit = "*"
 black = "*"
-coverage = "*"
 coveralls = "*"
 mypy = "*"
-pylama = {extras = ["all"], version = "*"}
+pre-commit = "*"
 pytest = "*"
+ruff = "*"
 
 [requires]
-python_version = "3.10"
+python_version = "3.11"
 
 [scripts]
 my_app = "python -c \"from my_app.cli import main; main()\""

Pipfile.lock

@@ -13,10 +13,10 @@
 @click.option(
     "-v", "--verbose", is_flag=True, help="Pass to log at debug level instead of info"
 )
-def main(verbose: bool) -> None:
+def main(*, verbose: bool) -> None:
     start_time = perf_counter()
     root_logger = logging.getLogger()
-    logger.info(configure_logger(root_logger, verbose))
+    logger.info(configure_logger(root_logger, verbose=verbose))
     logger.info(configure_sentry())
     logger.info("Running process")
 

my_app/cli.py

@@ -4,7 +4,7 @@
 import sentry_sdk
 
 
-def configure_logger(logger: logging.Logger, verbose: bool) -> str:
+def configure_logger(logger: logging.Logger, *, verbose: bool) -> str:
     if verbose:
         logging.basicConfig(
             format="%(asctime)s %(levelname)s %(name)s.%(funcName)s() line %(lineno)d: "

my_app/config.py

@@ -0,0 +1,69 @@
+# We do our best to sync this template with the latest version in our internal documentation.
+# For MIT developers, we strongly recommend copying the pyproject.toml template from:
+# https://mitlibraries.atlassian.net/wiki/spaces/IN/pages/3432415247/Python+Project+Linters#Template-for-pyproject.toml
+
+[tool.black]
+line-length = 90
+
+[tool.mypy]
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+exclude = ["tests/"]
+
+[tool.pytest.ini_options]
+log_level = "INFO"
+
+[tool.ruff]
+target-version = "py311"
+select = ["ALL", "PT"]
+
+ignore = [
+    # default
+    "ANN101", 
+    "ANN102", 
+    "COM812", 
+    "D107", 
+    "N812", 
+    "PTH", 
+
+    # project-specific
+    "C90",
+    "D100",
+    "D101", 
+    "D102",
+    "D103",
+    "D104", 
+    "PLR0912",
+    "PLR0913", 
+    "PLR0915",
+    "S320",
+    "S321", 
+]
+
+# allow autofix behavior for specified rules
+fixable = ["E", "F", "I", "Q"]
+
+# set max line length
+line-length = 90
+
+# enumerate all fixed violations
+show-fixes = true
+
+[tool.ruff.flake8-annotations]
+mypy-init-return = true
+
+[tool.ruff.flake8-pytest-style]
+fixture-parentheses = false
+
+[tool.ruff.per-file-ignores]
+"tests/**/*" = [
+    "ANN",
+    "ARG001",
+    "S101",
+]
+
+[tool.ruff.pycodestyle]
+max-doc-length = 90
+
+[tool.ruff.pydocstyle]
+convention = "google"

pyproject.toml

@@ -5,11 +5,11 @@
 
 
 @pytest.fixture(autouse=True)
-def test_env():
-    os.environ = {"SENTRY_DSN": None, "WORKSPACE": "test"}
-    yield
+def _test_env():
+    os.environ["SENTRY_DSN"] = "None"
+    os.environ["WORKSPACE"] = "test"
 
 
-@pytest.fixture()
+@pytest.fixture
 def runner():
     return CliRunner()