meta: lint-generated-project

Author: 56kyle

noxfile.py

@@ -32,7 +32,7 @@
 GITHUB_USER: str = "56kyle"
 
 ENV: str = "env"
-STYLE: str = "style"
+FORMAT: str = "format"
 LINT: str = "lint"
 TYPE: str = "type"
 TEST: str = "test"
@@ -42,15 +42,16 @@
 DOCS: str = "docs"
 BUILD: str = "build"
 RELEASE: str = "release"
-MAINTENANCE: str = "maintenance"
 CI: str = "ci"
+PYTHON: str = "python"
+RUST: str = "rust"
 
 
 @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, "-u", GITHUB_USER, "-n", PROJECT_NAME, external=True
+        "python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, external=True
     )
 
 
@@ -60,7 +61,8 @@ 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")
+
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="pre-commit", tags=[CI])
 def precommit(session: Session) -> None:
     """Lint using pre-commit."""
     args: list[str] = session.posargs or ["run", "--all-files", "--hook-stage=manual", "--show-diff-on-failure"]
@@ -73,21 +75,42 @@ def precommit(session: Session) -> None:
         activate_virtualenv_in_precommit_hooks(session)
 
 
-@nox.session(python=PYTHON_VERSIONS, name="typecheck", tags=[TYPE])
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="format-python", tags=[FORMAT, PYTHON])
+def format_python(session: Session) -> None:
+    """Run Python code formatter (Ruff format)."""
+    session.log("Installing formatting dependencies...")
+    session.install("-e", ".", "--group", "dev")
+
+    session.log(f"Running Ruff formatter check with py{session.python}.")
+    # Use --check, not fix. Fixing is done by pre-commit or manual run.
+    session.run("ruff", "format", *session.posargs)
+
+
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="lint-python", tags=[LINT, PYTHON])
+def lint_python(session: Session) -> None:
+    """Run Python code linters (Ruff check, Pydocstyle rules)."""
+    session.log("Installing linting dependencies...")
+    session.install("-e", ".", "--group", "dev")
+
+    session.log(f"Running Ruff check with py{session.python}.")
+    session.run("ruff", "check", "--verbose")
+
+
+@nox.session(python=PYTHON_VERSIONS, name="typecheck", tags=[TYPE, PYTHON, CI])
 def typecheck(session: Session) -> None:
     """Run static type checking (Pyright) on Python code."""
     session.log("Installing type checking dependencies...")
-    session.install("-e", ".", "--group", "dev", "--group", "typecheck")
+    session.install("-e", ".", "--group", "dev")
 
     session.log(f"Running Pyright check with py{session.python}.")
     session.run("pyright")
 
 
-@nox.session(python=DEFAULT_PYTHON_VERSION, name="security-python", tags=[SECURITY])
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="security-python", tags=[SECURITY, PYTHON, CI])
 def security_python(session: Session) -> None:
     """Run code security checks (Bandit) on Python code."""
     session.log("Installing security dependencies...")
-    session.install("-e", ".", "--group", "dev", "--group", "security")
+    session.install("-e", ".", "--group", "dev")
 
     session.log(f"Running Bandit static security analysis with py{session.python}.")
     session.run("bandit", "-r", PACKAGE_NAME, "-c", "bandit.yml", "-ll")
@@ -96,11 +119,11 @@ def security_python(session: Session) -> None:
     session.run("pip-audit")
 
 
-@nox.session(python=PYTHON_VERSIONS, name="tests-python", tags=[TEST])
+@nox.session(python=PYTHON_VERSIONS, name="tests-python", tags=[TEST, PYTHON, CI])
 def tests_python(session: Session) -> None:
     """Run the Python test suite (pytest with coverage)."""
     session.log("Installing test dependencies...")
-    session.install("-e", ".", "--group", "dev", "--group", "test")
+    session.install("-e", ".", "--group", "dev")
 
     session.log(f"Running test suite with py{session.python}.")
     test_results_dir = Path("test-results")
@@ -120,7 +143,7 @@ def tests_python(session: Session) -> None:
 def docs_build(session: Session) -> None:
     """Build the project documentation (Sphinx)."""
     session.log("Installing documentation dependencies...")
-    session.install("-e", ".", "--group", "dev", "--group", "docs")
+    session.install("-e", ".", "--group", "dev")
 
     session.log(f"Building documentation with py{session.python}.")
     docs_build_dir = Path("docs") / "_build" / "html"
@@ -132,7 +155,7 @@ def docs_build(session: Session) -> None:
     session.run("sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-W")
 
 
-@nox.session(python=DEFAULT_PYTHON_VERSION, name="build-python", tags=[BUILD])
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="build-python", tags=[BUILD, PYTHON])
 def build_python(session: Session) -> None:
     """Build sdist and wheel packages (uv build)."""
     session.log("Installing build dependencies...")
@@ -232,7 +255,7 @@ def release(session: Session) -> None:
     )
 
 
-@nox.session(venv_backend="none", tags=[MAINTENANCE])
+@nox.session(venv_backend="none")
 def tox(session: Session) -> None:
     """Run the 'tox' test matrix.
 
@@ -266,7 +289,7 @@ def coverage(session: Session) -> None:
     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", "--group", "test")
+    session.install("-e", ".", "--group", "dev")
 
     coverage_combined_file: Path = Path.cwd() / ".coverage"
 

pyproject.toml

@@ -28,28 +28,18 @@ dev = [
     "nox>=2025.5.1",
     "pre-commit>=4.2.0",
     "pre-commit-hooks>=5.0.0",
-]
-docs = [
     "furo>=2024.8.6",
     "myst-parser>=3.0.1",
     "sphinx>=7.4.7",
     "sphinx-autodoc-typehints>=2.3.0",
     "sphinx-copybutton>=0.5.2",
     "sphinx-tabs>=3.4.7",
-]
-lint = [
     "pydocstyle>=6.3.0",
     "ruff>=0.11.9",
-]
-security = [
     "bandit>=1.8.3",
     "pip-audit>=2.9.0",
-]
-test = [
     "pytest>=8.3.5",
     "pytest-cov>=6.1.1",
-]
-typecheck = [
     "pyright>=1.1.400",
 ]
 
@@ -59,4 +49,4 @@ Repository = "https://github.com/56kyle/robust-python-demo"
 
 [build-system]
 requires = ["setuptools>=61.0" ]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta" 

scripts/setup-git.py

@@ -1,6 +1,6 @@
 """Script responsible for first time setup of the project's git repo.
 
-Since this a first time setup script, we intentionally only use builtin Python dependencies.
+Since this is a first time setup script, we intentionally only use builtin Python dependencies.
 """
 import argparse
 import subprocess
@@ -14,25 +14,18 @@ def main() -> None:
     """Parses command line input and passes it through to setup_git."""
     parser: argparse.ArgumentParser = get_parser()
     args: argparse.Namespace = parser.parse_args()
-    setup_git(path=args.path, github_user=args.github_user, repo_name=args.repo_name)
+    setup_git(path=args.path)
 
 
-def setup_git(path: Path, github_user: str, repo_name: str) -> None:
+def setup_git(path: Path) -> None:
     """Set up the provided cookiecutter-robust-python project's git repo."""
     commands: list[list[str]] = [
         ["git", "init"],
         ["git", "branch", "-m", "master", "main"],
         ["git", "checkout", "main"],
-        ["git", "remote", "add", "origin", f"https://github.com/{github_user}/{repo_name}.git"],
-        ["git", "remote", "set-url", "origin", f"https://github.com/{github_user}/{repo_name}.git"],
-        ["git", "fetch", "origin"],
-        ["git", "pull"],
-        ["git", "push", "-u", "origin", "main"],
         ["git", "checkout", "-b", "develop", "main"],
-        ["git", "push", "-u", "origin", "develop"],
         ["git", "add", "."],
         ["git", "commit", "-m", "feat: initial commit"],
-        ["git", "push", "origin", "develop"]
     ]
     check_dependencies(path=path, dependencies=["git"])
 
@@ -53,8 +46,6 @@ def get_parser() -> argparse.ArgumentParser:
         metavar="PATH",
         help="Path to the repo's root directory (must already exist).",
     )
-    parser.add_argument("-u", "--user", dest="github_user", help="GitHub user name.")
-    parser.add_argument("-n", "--name", dest="repo_name", help="Name of the repo.")
     return parser
 
 

scripts/setup-remote.py

@@ -0,0 +1,53 @@
+"""Script responsible for first time setup of the project's git repo's remote connection.
+
+Since this is a first time setup script, we intentionally only use builtin Python dependencies.
+"""
+import argparse
+import subprocess
+from pathlib import Path
+
+from util import check_dependencies
+from util import existing_dir
+
+
+def main() -> None:
+    """Parses command line input and passes it through to setup_git."""
+    parser: argparse.ArgumentParser = get_parser()
+    args: argparse.Namespace = parser.parse_args()
+    setup_remote(path=args.path, github_user=args.github_user, repo_name=args.repo_name)
+
+
+def setup_remote(path: Path, github_user: str, repo_name: str) -> None:
+    """Set up the provided cookiecutter-robust-python project's git repo."""
+    commands: list[list[str]] = [
+        ["git", "fetch", "origin"],
+        ["git", "remote", "add", "origin", f"https://github.com/{github_user}/{repo_name}.git"],
+        ["git", "remote", "set-url", "origin", f"https://github.com/{github_user}/{repo_name}.git"],
+        ["git", "pull"],
+        ["git", "checkout", "main"],
+        ["git", "push", "-u", "origin", "main"],
+        ["git", "checkout", "develop"],
+        ["git", "push", "-u", "origin", "develop"],
+    ]
+    check_dependencies(path=path, dependencies=["git"])
+
+    for command in commands:
+        subprocess.run(command, cwd=path, stderr=subprocess.STDOUT)
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """Creates the argument parser for setup-git."""
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
+        prog="setup-git",
+        usage="python ./scripts/setup-remote.py . -u 56kyle -n robust-python-demo",
+        description="Set up the provided cookiecutter-robust-python project's remote repo connection.",
+    )
+    parser.add_argument(
+        "path",
+        type=existing_dir,
+        metavar="PATH",
+        help="Path to the repo's root directory (must already exist).",
+    )
+    parser.add_argument("-u", "--user", dest="github_user", help="GitHub user name.")
+    parser.add_argument("-n", "--name", dest="repo_name", help="Name of the repo.")
+    return parser