feat: add new scripts in scripts folder and move some of the initial setup logic into them

Author: 56kyle

tests/constants.py

@@ -18,7 +18,7 @@
 PYTHON_VERSIONS: list[str] = [f"3.{VERSION_SLUG}" for VERSION_SLUG in range(MIN_PYTHON_SLUG, MAX_PYTHON_SLUG + 1)]
 DEFAULT_PYTHON_VERSION: str = PYTHON_VERSIONS[1]
 
-
+FIRST_TIME_SETUP_NOX_SESSIONS: list[str] = ["setup-git", "setup-venv", "setup-repo"]
 TYPE_CHECK_NOX_SESSIONS: list[str] = [f"typecheck-{python_version}" for python_version in PYTHON_VERSIONS]
 TESTS_NOX_SESSIONS: list[str] = [f"tests-{python_version}" for python_version in PYTHON_VERSIONS]
 CHECK_NOX_SESSIONS: list[str] = [f"check-{python_version}" for python_version in PYTHON_VERSIONS]

{{cookiecutter.project_name}}/noxfile.py

@@ -23,7 +23,8 @@
 ]
 DEFAULT_PYTHON_VERSION: str = PYTHON_VERSIONS[-1]
 
-REPO_ROOT: Path = Path(__file__).parent
+REPO_ROOT: Path = Path(__file__).parent.resolve()
+SCRIPTS_FOLDER: Path = REPO_ROOT / "scripts"
 CRATES_FOLDER: Path = REPO_ROOT / "rust"
 PACKAGE_NAME: str = "{{cookiecutter.package_name}}"
 GITHUB_USER: str = "{{cookiecutter.github_user}}"
@@ -44,31 +45,16 @@ def setup_repo(session: Session) -> None:
 @nox.session(python=None, name="setup-git")
 def setup_git(session: Session) -> None:
     """Set up the git repo for the current project."""
-    session.run("git", "init")
-    session.run("git", "branch", "-M", "main")
-
     session.run(
-        "git", "remote", "add", "origin", f"https://github.com/{GITHUB_USER}/{PACKAGE_NAME}.git", "||", "true"
+        "python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, "-u", GITHUB_USER, "-n", PACKAGE_NAME, external=True
     )
-    session.run("git", "remote", "set-url", "origin", f"https://github.com/{GITHUB_USER}/{PACKAGE_NAME}.git")
-    session.run("git", "fetch", "origin")
-
-    session.run("git", "push", "-u", "origin", "main")
-    session.run("git", "checkout", "-b", "develop", "main")
-    session.run("git", "push", "-u", "origin", "develop")
-
-    session.run("git", "add", ".")
-    session.run("git", "commit", "-m", "feat: initial commit")
-    session.run("git", "push", "origin", "develop")
 
 
 @nox.session(python=None, name="setup-venv")
 def setup_venv(session: Session) -> None:
-    session.run("uv", "lock", external=True)
-    session.run("uv", "venv", ".venv", external=True)
-    session.run("uv", "python", "install", PYTHON_VERSIONS[0], external=True)
-    session.run("uv", "python", "pin", PYTHON_VERSIONS[0], external=True)
-    session.run("uv", "sync", "--all-groups", external=True)
+    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")

{{cookiecutter.project_name}}/scripts/setup-git.py

@@ -0,0 +1,57 @@
+"""Script responsible for coordinating first time project setup."""
+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_git(path=args.path, github_user=args.github_user, repo_name=args.repo_name)
+
+
+def setup_git(path: Path, github_user: str, repo_name: str) -> None:
+    """Set up the provided cookiecutter-robust-python project for the first time."""
+    commands: list[list[str]] = [
+        ["git", "init"],
+        ["git", "branch", "-M", "main"],
+        ["git", "remote", "add", "origin", f"https://github.com/{github_user}/{repo_name}.git", "||", "true"],
+        ["git", "remote", "set-url", "origin", f"https://github.com/{github_user}/{repo_name}.git"],
+        ["git", "fetch", "origin"],
+        ["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"])
+
+    for command in commands:
+        subprocess.run(command, cwd=path, capture_output=True)
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """Creates the argument parser for setup-git."""
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
+        prog="setup-git",
+        usage="python ./scripts/setup-git.py . -u 56kyle -n robust-python-demo",
+        description="Set up the provided cookiecutter-robust-python project's git repo.",
+    )
+    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
+
+
+if __name__ == '__main__':
+    main()

{{cookiecutter.project_name}}/scripts/setup-venv.py

@@ -0,0 +1,54 @@
+"""Script responsible for coordinating first time project setup."""
+import argparse
+import subprocess
+from pathlib import Path
+
+from util import check_dependencies
+from util import existing_dir
+
+
+def main() -> None:
+    """Parses args and passes through to setup_venv."""
+    parser: argparse.ArgumentParser = get_parser()
+    args: argparse.Namespace = parser.parse_args()
+    setup_venv(path=args.path, python_version=args.python_version)
+
+
+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'"
+    )
+    parser.add_argument(
+        "path",
+        type=existing_dir,
+        metavar="PATH",
+        help="Path to the repo's root directory (must already exist).",
+    )
+    parser.add_argument(
+        "-p",
+        "--python",
+        dest="python_version",
+        help="The Python version that will serve as the main working version used by the IDE."
+    )
+    return parser
+
+
+def setup_venv(path: Path, python_version: str) -> None:
+    """Set up the provided cookiecutter-robust-python project's venv."""
+    commands: list[list[str]] = [
+        ["uv", "lock"],
+        ["uv", "venv", ".venv"],
+        ["uv", "python", "install", python_version],
+        ["uv", "python", "pin", python_version],
+        ["uv", "sync", "--all-groups"]
+    ]
+    check_dependencies(path=path, dependencies=["uv"])
+
+    for command in commands:
+        subprocess.run(command, cwd=path, capture_output=True)
+
+
+if __name__ == '__main__':
+    main()

{{cookiecutter.project_name}}/scripts/util.py

@@ -0,0 +1,34 @@
+"""Module containing util"""
+import argparse
+import subprocess
+from pathlib import Path
+
+
+class MissingDependencyError(Exception):
+    """Exception raised when a depedency is missing from the system running setup-repo."""
+    def __init__(self, project: Path, dependency: str):
+        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:
+    """Checks for any passed dependencies."""
+    for dependency in dependencies:
+        try:
+            subprocess.check_call([dependency, "--version"], cwd=path)
+        except subprocess.CalledProcessError:
+            raise MissingDependencyError(path, dependency)
+
+
+def existing_dir(value: str) -> Path:
+    """Responsible for validating argparse inputs and returning them as pathlib Path's if they meet criteria."""
+    path = Path(value).expanduser().resolve()
+
+    if not path.exists():
+        raise argparse.ArgumentTypeError(f"{path} does not exist.")
+    if not path.is_dir():
+        raise argparse.ArgumentTypeError(f"{path} is not a directory.")
+
+    return path