Update Flake8 Config, Update Code Style, Tweak Dependencies

- Update flake8 config with `.flake8` file
  and changes to `python-package.yml`
- Update code style to comply with flake8 config
- Tweak dependencies in `requirements.txt`
  and `pyproject.toml`

Author: SyntaxAerror

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+ignore = E261
+max-line-length = 200
+exclude = .git,.github,__pycache__,.pytest_cache,.venv,.venv_test,.vscode
+max-complexity = 10

.github/workflows/python-package.yml

@@ -32,7 +32,7 @@ jobs:
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        flake8 . --count --select=E9,F63,F7,F82 --ignore=E261 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest

requirements.txt

@@ -1,4 +1,4 @@
-python-dotenv==1.1.1
 pytest==8.4.1
 pytest-cov==6.2.1
-pdoc==15.0.4
+pdoc==15.0.4
+flake8==7.3.0

stat_log_db/pyproject.toml

@@ -9,14 +9,12 @@ description = ""
 readme = "README.md"
 requires-python = "==3.12.10"
 dependencies = [
-    "python-dotenv==1.1.1"
 ]
 
 [project.optional-dependencies]
 dev = [
     "pytest==8.4.1",
-    "pytest-cov==6.2.1",
-    "pdoc==15.0.4"
+    "pytest-cov==6.2.1"
 ]
 
 [project.scripts]

stat_log_db/src/stat_log_db/__init__.py

@@ -1,2 +1,2 @@
 from . import exceptions
-from . import cli
+from . import cli

stat_log_db/src/stat_log_db/cli.py

@@ -1,14 +1,11 @@
 import os
 import sys
 import argparse
-from dotenv import load_dotenv
 
 from .exceptions import raise_type_error_with_signature
 
-load_dotenv()
 
-
-def create_parser(parser_args: dict, version: str | int="0.0.1") -> argparse.ArgumentParser:
+def create_parser(parser_args: dict, version: str | int = "0.0.1") -> argparse.ArgumentParser:
     """Create the main argument parser."""
     # Validate parser_args
     if not isinstance(parser_args, dict):
@@ -41,7 +38,7 @@ def main():
     parser = create_parser({
         "prog": "sldb",
         "description": "My CLI tool",
-    }, "0.0.1")
+    }, "0.0.1") # TODO: Read version from pyproject.toml?
 
     args = parser.parse_args()
 

tests/test_tools.py

@@ -6,28 +6,32 @@
 
 import pytest
 
-#region Global Variables
+
+# region Global Variables
 
 ROOT = Path(__file__).resolve().parent.parent
-SCRIPT = ROOT / 'tools.sh'
-VENV_TEST = ROOT / '.venv_test'
-PACKAGE_NAME = 'stat-log-db'
+SCRIPT = ROOT / "tools.sh"
+VENV_TEST = ROOT / ".venv_test"
+PACKAGE_NAME = "stat-log-db"
 
 GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "true"
 
-#endregion
+# endregion
+
 
+# region testing tools
 
-#region testing tools
 
 def _ensure_test_venv():
     """Ensure the test virtual environment is created."""
     if not VENV_TEST.exists():
-        subprocess.run([sys.executable, '-m', 'venv', str(VENV_TEST)], check=True)
+        subprocess.run([sys.executable, "-m", "venv", str(VENV_TEST)], check=True)
+
 
 def _venv_python():
     """Return path to the virtual environment's python interpreter."""
-    return VENV_TEST / ('Scripts' if os.name == 'nt' else 'bin') / ('python.exe' if os.name == 'nt' else 'python')
+    return VENV_TEST / ("Scripts" if os.name == "nt" else "bin") / ("python.exe" if os.name == "nt" else "python")
+
 
 def is_installed(package: str) -> bool:
     """
@@ -36,26 +40,28 @@ def is_installed(package: str) -> bool:
     """
     _ensure_test_venv()
     python_executable = _venv_python()
-    result = subprocess.run([str(python_executable), '-m', 'pip', 'show', package], capture_output=True, text=True)
+    result = subprocess.run([str(python_executable), "-m", "pip", "show", package], capture_output=True, text=True)
     return result.returncode == 0
 
+
 def run_tools(args, use_test_venv=False):
     """Run tools.sh returning (code, stdout+stderr)."""
     env = os.environ.copy()
     if use_test_venv:
         _ensure_test_venv()
-        scripts_dir = VENV_TEST / ('Scripts' if os.name == 'nt' else 'bin')
-        env['PATH'] = str(scripts_dir) + os.pathsep + env.get('PATH', '')
-        env['VIRTUAL_ENV'] = str(VENV_TEST)
-        env['PYTHONHOME'] = '' # ensure venv python resolution
-    bash = r'C:\Program Files\Git\bin\bash.exe' if os.name == 'nt' else 'bash' # TODO: indicate to the user that they need git bash
+        scripts_dir = VENV_TEST / ("Scripts" if os.name == "nt" else "bin")
+        env["PATH"] = str(scripts_dir) + os.pathsep + env.get("PATH", "")
+        env["VIRTUAL_ENV"] = str(VENV_TEST)
+        env["PYTHONHOME"] = ""  # ensure venv python resolution
+    bash = r"C:\Program Files\Git\bin\bash.exe" if os.name == "nt" else "bash"  # TODO: indicate to the user that they need git bash
     proc = subprocess.run([bash, str(SCRIPT), *args], capture_output=True, text=True, cwd=ROOT, env=env)
     return proc.returncode, proc.stdout + proc.stderr
 
-#endregion
+
+# endregion
 
 
-@pytest.fixture() # scope="module"
+@pytest.fixture()  # scope="module"
 def test_venv():
     """
     Provision an isolated virtual environment used for install/uninstall tests.
@@ -69,13 +75,13 @@ def test_venv():
 
 
 def test_help():
-    code, out = run_tools(['-h'])
+    code, out = run_tools(["-h"])
     assert code == 0
     # Read README.md
-    readme_path = ROOT / 'README.md'
+    readme_path = ROOT / "README.md"
     assert readme_path.exists(), f"README not found at {readme_path}"
     readme_content = None
-    with open(readme_path, 'r', encoding='utf-8') as f:
+    with open(readme_path, "r", encoding="utf-8") as f:
         readme_content = f.read().strip()
     assert not (readme_content is None), "Unable to read README"
     # Compare README content with help output
@@ -84,66 +90,74 @@ def test_help():
     except AssertionError:
         assert out.strip() == readme_content.strip(), "Help output does not match README content (leading & trailing whitespace stripped)"
 
+
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_install_dev(test_venv):
-    code, out = run_tools(['-id'], use_test_venv=True)
+    code, out = run_tools(["-id"], use_test_venv=True)
     assert code == 0
-    assert 'Installing' in out
-    assert 'dev' in out
-    assert is_installed(PACKAGE_NAME), 'Package should be installed after dev install'
+    assert "Installing" in out
+    assert "dev" in out
+    assert is_installed(PACKAGE_NAME), "Package should be installed after dev install"
+
 
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_install_normal(test_venv):
-    code, out = run_tools(['-in'], use_test_venv=True)
+    code, out = run_tools(["-in"], use_test_venv=True)
     assert code == 0
-    assert 'Installing' in out
-    assert 'dev' not in out
-    assert is_installed(PACKAGE_NAME), 'Package should be installed after normal install'
+    assert "Installing" in out
+    assert "dev" not in out
+    assert is_installed(PACKAGE_NAME), "Package should be installed after normal install"
+
 
 def test_install_invalid_arg(test_venv):
-    code, out = run_tools(['-ix'], use_test_venv=True)
+    code, out = run_tools(["-ix"], use_test_venv=True)
     assert code == 1
-    assert ('Unsupported argument' in out) or ('Invalid install mode' in out)
-    assert not is_installed(PACKAGE_NAME), 'Package should not be installed after invalid install argument'
+    assert ("Unsupported argument" in out) or ("Invalid install mode" in out)
+    assert not is_installed(PACKAGE_NAME), "Package should not be installed after invalid install argument"
+
 
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_uninstall(test_venv):
     # Ensure something installed first (dev mode)
-    icode, iout = run_tools(['-id'], use_test_venv=True)
+    icode, iout = run_tools(["-id"], use_test_venv=True)
     assert icode == 0
-    assert is_installed(PACKAGE_NAME), 'Package should be installed (before uninstall)'
-    ucode, uout = run_tools(['-u'], use_test_venv=True)
+    assert is_installed(PACKAGE_NAME), "Package should be installed (before uninstall)"
+    ucode, uout = run_tools(["-u"], use_test_venv=True)
     assert ucode == 0
-    assert 'Uninstalling' in uout
-    assert 'Uninstall complete' in uout
-    assert not is_installed(PACKAGE_NAME), 'Package should not be installed after uninstall'
+    assert "Uninstalling" in uout
+    assert "Uninstall complete" in uout
+    assert not is_installed(PACKAGE_NAME), "Package should not be installed after uninstall"
+
 
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_install_and_clean_multi_flag(test_venv):
-    code, out = run_tools(['-id', '-c'], use_test_venv=True)
+    code, out = run_tools(["-id", "-c"], use_test_venv=True)
     assert code == 0
-    assert is_installed(PACKAGE_NAME), 'Package should be installed'
-    assert 'Installing' in out
-    assert 'Cleaning up workspace' in out
-    assert 'Cleanup complete' in out
-    assert is_installed(PACKAGE_NAME), 'Cleanup should not remove installed package'
+    assert is_installed(PACKAGE_NAME), "Package should be installed"
+    assert "Installing" in out
+    assert "Cleaning up workspace" in out
+    assert "Cleanup complete" in out
+    assert is_installed(PACKAGE_NAME), "Cleanup should not remove installed package"
+
 
 def test_test_no_arg():
-    code, out = run_tools(['-t'])
+    code, out = run_tools(["-t"])
     assert code == 1
     try:
-        assert out == 'Option -t requires an argument'
+        assert out == "Option -t requires an argument"
     except AssertionError:
-        assert out.strip() == 'Option -t requires an argument'
+        assert out.strip() == "Option -t requires an argument"
+
 
 def test_test_invalid_arg():
-    code, out = run_tools(['-tx'])
+    code, out = run_tools(["-tx"])
     assert code == 1
-    assert ('Unsupported argument' in out) or ('Invalid test mode' in out)
+    assert ("Unsupported argument" in out) or ("Invalid test mode" in out)
+
 
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_clean():
-    code, out = run_tools(['-c'])
+    code, out = run_tools(["-c"])
     assert code == 0
-    assert 'Cleaning up workspace' in out
-    assert 'Cleanup complete' in out
+    assert "Cleaning up workspace" in out
+    assert "Cleanup complete" in out