feat: add preparations for moving to org

Author: 56kyle

.env

@@ -0,0 +1,11 @@
+# Default environment variables for cookiecutter-robust-python
+# Users can override these by creating a .env.local file (not committed to git)
+
+# App author name used for cache directory paths
+COOKIECUTTER_ROBUST_PYTHON_APP_AUTHOR=robust-python
+
+# Main branch name (typically used for stable releases)
+COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH=main
+
+# Development branch name (where feature development occurs)
+COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH=develop

.gitignore

@@ -62,4 +62,7 @@ Thumbs.db      # Windows thumbnail cache
 debug.log
 nohup.out
 
+# Local environment overrides
+.env.local
+
 /.idea/

docs/maintenance.md

@@ -22,6 +22,29 @@ uv sync # This installs deps from the template's pyproject.toml into a .venv for
 
 Refer to the [Getting Started: Contributing to the Template](getting-started-template-contributing.md) guide for initial setup details.
 
+## Customizing Template Development with .env.local
+
+The template uses environment variables to make demo generation and repository management scripts user-agnostic. Default values are provided in `.env` at the template repository root.
+
+### Available Environment Variables
+
+- `COOKIECUTTER_ROBUST_PYTHON_APP_AUTHOR` - App author name used for cache directory paths (default: `robust-python`)
+- `COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH` - Main branch name for version control (default: `main`)
+- `COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH` - Development branch name (default: `develop`)
+
+### Overriding Defaults
+
+If you maintain your own forks of the demo repositories or use different branch conventions, create a `.env.local` file at the template repository root (this file is git-ignored and will not be committed):
+
+```bash
+# .env.local (not committed to git)
+COOKIECUTTER_ROBUST_PYTHON_APP_AUTHOR=my-org
+COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH=master
+COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH=development
+```
+
+Alternatively, you can set these as system environment variables directly, and the `.env.local` file will override them if present.
+
 ## Task Automation for Template Maintenance
 
 The template repository uses its own `noxfile.py` at the **template repository root** (separate from the `noxfile.py` generated in projects) to automate common template maintenance tasks. These tasks run within the template's development environment.

noxfile.py

@@ -5,6 +5,7 @@
 
 import nox
 import platformdirs
+from dotenv import load_dotenv
 from nox.command import CommandFailed
 from nox.sessions import Session
 
@@ -18,10 +19,19 @@
 TEMPLATE_FOLDER: Path = REPO_ROOT / "{{cookiecutter.project_name}}"
 
 
+# Load environment variables from .env and .env.local (if present)
+_env_file: Path = REPO_ROOT / ".env"
+_env_local_file: Path = REPO_ROOT / ".env.local"
+if _env_file.exists():
+    load_dotenv(_env_file)
+if _env_local_file.exists():
+    load_dotenv(_env_local_file, override=True)
+
+APP_AUTHOR: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_APP_AUTHOR", "robust-python")
 COOKIECUTTER_ROBUST_PYTHON_CACHE_FOLDER: Path = Path(
     platformdirs.user_cache_path(
         appname="cookiecutter-robust-python",
-        appauthor="56kyle",
+        appauthor=APP_AUTHOR,
         ensure_exists=True,
     )
 ).resolve()

scripts/lint-from-demo.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 from typing import Annotated
 
@@ -28,22 +29,23 @@ def lint_from_demo(
     no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False
 ) -> None:
     """Runs precommit in a generated project and matches the template to the results."""
+    develop_branch: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH", "develop")
     with in_new_demo(
         demos_cache_folder=demos_cache_folder,
         add_rust_extension=add_rust_extension,
         no_cache=no_cache
     ) as demo_path:
         require_clean_and_up_to_date_repo()
-        git("checkout", "develop")
+        git("checkout", develop_branch)
         git("branch", "-D", "temp/lint-from-demo", ignore_error=True)
-        git("checkout", "-b", "temp/lint-from-demo", "develop")
+        git("checkout", "-b", "temp/lint-from-demo", develop_branch)
         pre_commit.main.main(["run", "--all-files", "--show-diff-on-failure"])
 
         for path in IGNORED_FILES:
             git("checkout", "HEAD", "--", path)
         git("add", ".")
         git("commit", "-m", "meta: lint-from-demo", "--no-verify")
-    retrocookie(instance_path=demo_path, commits=["develop..temp/lint-from-demo"])
+    retrocookie(instance_path=demo_path, commits=[f"{develop_branch}..temp/lint-from-demo"])
 
 
 if __name__ == '__main__':

scripts/update-demo.py

@@ -1,3 +1,4 @@
+import os
 import sys
 from pathlib import Path
 from typing import Annotated
@@ -23,12 +24,13 @@ def update_demo(
 ) -> None:
     """Runs precommit in a generated project and matches the template to the results."""
     try:
+        develop_branch: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH", "develop")
         demo_name: str = get_demo_name(add_rust_extension=add_rust_extension)
         demo_path: Path = demos_cache_folder / demo_name
         typer.secho(f"Updating demo project at {demo_path=}.", fg="yellow")
         with work_in(demo_path):
             require_clean_and_up_to_date_repo()
-            git("checkout", "develop")
+            git("checkout", develop_branch)
             cruft.update(
                 project_dir=demo_path,
                 template_path=REPO_FOLDER,

scripts/util.py

@@ -17,12 +17,32 @@
 import cruft
 import typer
 from cookiecutter.utils import work_in
+from dotenv import load_dotenv
 from typer.models import OptionInfo
 
 
 REPO_FOLDER: Path = Path(__file__).resolve().parent.parent
 
 
+def _load_env() -> None:
+    """Load environment variables from .env and .env.local (if present).
+
+    .env.local takes precedence over .env for any overlapping variables.
+    """
+    env_file: Path = REPO_FOLDER / ".env"
+    env_local_file: Path = REPO_FOLDER / ".env.local"
+
+    if env_file.exists():
+        load_dotenv(env_file)
+
+    if env_local_file.exists():
+        load_dotenv(env_local_file, override=True)
+
+
+# Load environment variables at module import time
+_load_env()
+
+
 FolderOption: partial[OptionInfo] = partial(
     typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path
 )
@@ -66,14 +86,17 @@ def run_command(command: str, *args: str, ignore_error: bool = False) -> Optiona
 
 def require_clean_and_up_to_date_repo() -> None:
     """Checks if the repo is clean and up to date with any important branches."""
+    main_branch: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH", "main")
+    develop_branch: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH", "develop")
+
     git("fetch")
     git("status", "--porcelain")
-    if not is_branch_synced_with_remote("develop"):
-        raise ValueError("develop is not synced with origin/develop")
-    if not is_branch_synced_with_remote("main"):
-        raise ValueError("main is not synced with origin/main")
-    if not is_ancestor("main", "develop"):
-        raise ValueError("main is not an ancestor of develop")
+    if not is_branch_synced_with_remote(develop_branch):
+        raise ValueError(f"{develop_branch} is not synced with origin/{develop_branch}")
+    if not is_branch_synced_with_remote(main_branch):
+        raise ValueError(f"{main_branch} is not synced with origin/{main_branch}")
+    if not is_ancestor(main_branch, develop_branch):
+        raise ValueError(f"{main_branch} is not an ancestor of {develop_branch}")
 
 
 def is_branch_synced_with_remote(branch: str) -> bool: