meta: lint-generated-project

Author: 56kyle

noxfile.py

@@ -2,7 +2,6 @@
 
 import os
 import shlex
-
 from pathlib import Path
 from textwrap import dedent
 from typing import List
@@ -50,9 +49,7 @@
 @nox.session(python=None, name="setup-git", tags=[ENV])
 def setup_git(session: Session) -> None:
     """Set up the git repo for the current project."""
-    session.run(
-        "python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, external=True
-    )
+    session.run("python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, external=True)
 
 
 @nox.session(python=None, name="setup-venv", tags=[ENV])
@@ -61,7 +58,6 @@ def setup_venv(session: Session) -> None:
     session.run("python", SCRIPTS_FOLDER / "setup-venv.py", REPO_ROOT, "-p", PYTHON_VERSIONS[0], external=True)
 
 
-
 @nox.session(python=DEFAULT_PYTHON_VERSION, name="pre-commit", tags=[CI])
 def precommit(session: Session) -> None:
     """Lint using pre-commit."""
@@ -129,13 +125,7 @@ def tests_python(session: Session) -> None:
     test_results_dir.mkdir(parents=True, exist_ok=True)
     junitxml_file = test_results_dir / f"test-results-py{session.python}.xml"
 
-    session.run(
-        "pytest",
-        "--cov={}".format(PACKAGE_NAME),
-        "--cov-report=xml",
-        f"--junitxml={junitxml_file}",
-        "tests/"
-    )
+    session.run("pytest", "--cov={}".format(PACKAGE_NAME), "--cov-report=xml", f"--junitxml={junitxml_file}", "tests/")
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION, name="docs-build", tags=[DOCS, BUILD])
@@ -194,7 +184,15 @@ def build_container(session: Session) -> None:
 
     session.log(f"Building Docker image using {container_cli}.")
     project_image_name = PACKAGE_NAME.replace("_", "-").lower()
-    session.run(container_cli, "build", str(current_dir), "-t", f"{project_image_name}:latest", "--progress=plain", external=True)
+    session.run(
+        container_cli,
+        "build",
+        str(current_dir),
+        "-t",
+        f"{project_image_name}:latest",
+        "--progress=plain",
+        external=True,
+    )
 
     session.log(f"Container image {project_image_name}:latest built locally.")
 
@@ -243,15 +241,13 @@ def release(session: Session) -> None:
     cz_bump_args = ["uvx", "cz", "bump", "--changelog"]
 
     if increment:
-         cz_bump_args.append(f"--increment={increment}")
+        cz_bump_args.append(f"--increment={increment}")
 
     session.log("Running cz bump with args: %s", cz_bump_args)
     session.run(*cz_bump_args, success_codes=[0, 1], external=True)
 
     session.log("Version bumped and tag created locally via Commitizen/uvx.")
-    session.log(
-        "IMPORTANT: Push commits and tags to remote (`git push --follow-tags`) to trigger CD pipeline."
-    )
+    session.log("IMPORTANT: Push commits and tags to remote (`git push --follow-tags`) to trigger CD pipeline.")
 
 
 @nox.session(venv_backend="none")
@@ -285,7 +281,9 @@ def coverage(session: Session) -> None:
     (e.g., via `nox -s test-python`).
     """
     session.log("Collecting and reporting coverage across all test runs.")
-    session.log("Note: Ensure 'nox -s test-python' was run across all desired Python versions first to generate coverage data.")
+    session.log(
+        "Note: Ensure 'nox -s test-python' was run across all desired Python versions first to generate coverage data."
+    )
 
     session.log("Installing dependencies for coverage report session...")
     session.install("-e", ".", "--group", "dev")
@@ -298,9 +296,9 @@ def coverage(session: Session) -> None:
         session.log(f"Combined coverage data into {coverage_combined_file.resolve()}")
     except CommandFailed as e:
         if e.returncode == 1:
-             session.log("No coverage data found to combine. Run tests first with coverage enabled.")
+            session.log("No coverage data found to combine. Run tests first with coverage enabled.")
         else:
-             session.error(f"Failed to combine coverage data: {e}")
+            session.error(f"Failed to combine coverage data: {e}")
         session.skip("Could not combine coverage data.")
 
     session.log("Generating HTML coverage report.")

scripts/setup-git.py

@@ -2,6 +2,7 @@
 
 Since this is a first time setup script, we intentionally only use builtin Python dependencies.
 """
+
 import argparse
 import subprocess
 from pathlib import Path
@@ -49,5 +50,5 @@ def get_parser() -> argparse.ArgumentParser:
     return parser
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

scripts/setup-remote.py

@@ -2,6 +2,7 @@
 
 Since this is a first time setup script, we intentionally only use builtin Python dependencies.
 """
+
 import argparse
 import subprocess
 from pathlib import Path

scripts/setup-venv.py

@@ -2,6 +2,7 @@
 
 Since this a first time setup script, we intentionally only use builtin Python dependencies.
 """
+
 import argparse
 import shutil
 import subprocess
@@ -22,8 +23,7 @@ def main() -> None:
 def get_parser() -> argparse.ArgumentParser:
     """Creates the argument parser for setup-venv."""
     parser: argparse.ArgumentParser = argparse.ArgumentParser(
-        prog="setup-venv",
-        usage="python ./scripts/setup-venv.py . -p '3.9'"
+        prog="setup-venv", usage="python ./scripts/setup-venv.py . -p '3.9'"
     )
     parser.add_argument(
         "path",
@@ -35,7 +35,7 @@ def get_parser() -> argparse.ArgumentParser:
         "-p",
         "--python",
         dest="python_version",
-        help="The Python version that will serve as the main working version used by the IDE."
+        help="The Python version that will serve as the main working version used by the IDE.",
     )
     return parser
 
@@ -47,7 +47,7 @@ def setup_venv(path: Path, python_version: str) -> None:
         ["uv", "venv", ".venv"],
         ["uv", "python", "install", python_version],
         ["uv", "python", "pin", python_version],
-        ["uv", "sync", "--all-groups"]
+        ["uv", "sync", "--all-groups"],
     ]
     check_dependencies(path=path, dependencies=["uv"])
 
@@ -59,5 +59,5 @@ def setup_venv(path: Path, python_version: str) -> None:
         subprocess.run(command, cwd=path, capture_output=True)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

scripts/util.py

@@ -1,4 +1,5 @@
 """Module containing util."""
+
 import argparse
 import stat
 import subprocess
@@ -9,12 +10,17 @@
 
 class MissingDependencyError(Exception):
     """Exception raised when a depedency is missing from the system running setup-repo."""
+
     def __init__(self, project: Path, dependency: str):
         """Initializes MisssingDependencyError."""
-        super().__init__("\n".join([
-            f"Unable to find {dependency=}.",
-            f"Please ensure that {dependency} is installed before setting up the repo at {project.absolute()}"
-        ]))
+        super().__init__(
+            "\n".join(
+                [
+                    f"Unable to find {dependency=}.",
+                    f"Please ensure that {dependency} is installed before setting up the repo at {project.absolute()}",
+                ]
+            )
+        )
 
 
 def check_dependencies(path: Path, dependencies: list[str]) -> None:

src/robust_python_demo/__main__.py

@@ -5,6 +5,7 @@
 
 app: typer.Typer = typer.Typer()
 
+
 @app.command(name="robust-python-demo")
 def main() -> None:
     """Robust Python Demo."""