Merge pull request #44 from robust-python/develop

56kyle · web-flow · commit b2ba610a19e5 · 2025-11-01T07:51:57.000-04:00
Move to Org
diff --git a/.env b/.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
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
 blank_issues_enabled: true
 contact_links:
   - name: ❓ Questions & Support
-    url: https://github.com/56kyle/cookiecutter-robust-python/discussions
+    url: https://github.com/robust-python/cookiecutter-robust-python/discussions
     about: Ask questions and get help using cookiecutter-robust-python
   - name: 💬 General Discussion
-    url: https://github.com/56kyle/cookiecutter-robust-python/discussions
+    url: https://github.com/robust-python/cookiecutter-robust-python/discussions
     about: Discuss ideas, best practices, and share your projects
diff --git a/.gitignore b/.gitignore
@@ -62,4 +62,7 @@ Thumbs.db      # Windows thumbnail cache
 debug.log
 nohup.out
 
+# Local environment overrides
+.env.local
+
 /.idea/
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[56kyleoliver@gmail.com](mailto:56kyleoliver@gmail.com).
+[cookiecutter.robust.python@gmail.com](mailto:cookiecutter.robust.python@gmail.com).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,19 +8,19 @@ By participating in this project, you are expected to uphold our [Code of Conduc
 
 There are several ways to contribute:
 
-1.  **Reporting Bugs:** If you find an issue with the template itself (e.g., it doesn't generate correctly, the generated project's workflow doesn't work on a specific OS, a tool is misconfigured), please open an issue on the [issue tracker](https://github.com/56kyle/cookiecutter-robust-python/issues). Provide clear steps to reproduce the bug.
-2.  **Suggesting Enhancements:** Have an idea for a new feature, a different tool choice you think is better, or an improvement to the template structure or documentation? Open an issue on the [issue tracker](https://github.com/56kyle/cookiecutter-robust-python/issues) to discuss your suggestion. Clearly articulate the proposed change and the rationale behind it, ideally referencing the template's philosophy and criteria ([Template Philosophy](https://56kyle.github.io/cookiecutter-robust-python/philosophy.html), [Criteria for Tool Selection](https://56kyle.github.io/cookiecutter-robust-python/criteria.html)).
+1.  **Reporting Bugs:** If you find an issue with the template itself (e.g., it doesn't generate correctly, the generated project's workflow doesn't work on a specific OS, a tool is misconfigured), please open an issue on the [issue tracker](https://github.com/robust-python/cookiecutter-robust-python/issues). Provide clear steps to reproduce the bug.
+2.  **Suggesting Enhancements:** Have an idea for a new feature, a different tool choice you think is better, or an improvement to the template structure or documentation? Open an issue on the [issue tracker](https://github.com/robust-python/cookiecutter-robust-python/issues) to discuss your suggestion. Clearly articulate the proposed change and the rationale behind it, ideally referencing the template's philosophy and criteria ([Template Philosophy](https://robust-python.github.io/cookiecutter-robust-python/philosophy.html), [Criteria for Tool Selection](https://robust-python.github.io/cookiecutter-robust-python/criteria.html)).
 3.  **Submitting Code Contributions:** Ready to contribute code (e.g., fix a bug, implement a suggested enhancement, update a tool version)? Please fork the repository and submit a Pull Request.
 
 ## Setting Up Your Development Environment
 
-Refer to the **[Getting Started: Contributing to the Template](https://56kyle.github.io/cookiecutter-robust-python/getting-started-template-contributing.html)** section in the template documentation for instructions on cloning the repository, installing template development dependencies (using uv), setting up the template's pre-commit hooks, and running template checks/tests.
+Refer to the **[Getting Started: Contributing to the Template](https://robust-python.github.io/cookiecutter-robust-python/getting-started-template-contributing.html)** section in the template documentation for instructions on cloning the repository, installing template development dependencies (using uv), setting up the template's pre-commit hooks, and running template checks/tests.
 
 ## Contribution Workflow
 
 1.  **Fork** the repository and **clone** your fork.
 2.  Create a **new branch** for your contribution based on the main branch. Use a descriptive name (e.g., `fix/ci-workflow-on-windows`, `feat/update-uv-version`).
-3.  Set up your development environment following the [Getting Started](https://56kyle.github.io/cookiecutter-robust-python/getting-started-template-contributing.html) guide (clone, `uv sync`, `uvx nox -s pre-commit -- install`).
+3.  Set up your development environment following the [Getting Started](https://robust-python.github.io/cookiecutter-robust-python/getting-started-template-contributing.html) guide (clone, `uv sync`, `uvx nox -s pre-commit -- install`).
 4.  Make your **code or documentation changes**.
 5.  Ensure your changes adhere to the template's **code quality standards** (configured in the template's `.pre-commit-config.yaml`, `.ruff.toml`, etc.). The pre-commit hooks will help with this. Run `uvx nox -s lint`, `uvx nox -s check` in the template repository for more comprehensive checks.
 6.  Ensure your changes **do not break existing functionality**. Run the template's test suite: `uvx nox -s test`. Ideally, add tests for new functionality or bug fixes.
@@ -35,6 +35,6 @@ If your contribution involves updating a major tool version or suggesting a diff
 
 ## Communication
 
-For questions or discussion about contributions, open an issue or a discussion on the [GitHub repository](https://github.com/56kyle/cookiecutter-robust-python).
+For questions or discussion about contributions, open an issue or a discussion on the [GitHub repository](https://github.com/robust-python/cookiecutter-robust-python).
 
 ---
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ A Python project template robust enough to follow up [cookiecutter-hypermodern-p
 
 ---
 
-**[📚 View Documentation](https://cookiecutter-robust-python.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/56kyle/cookiecutter-robust-python/issues)** | **[✨ Request a Feature](https://github.com/56kyle/cookiecutter-robust-python/issues)**
+**[📚 View Documentation](https://cookiecutter-robust-python.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/robust-python/cookiecutter-robust-python/issues)** | **[✨ Request a Feature](https://github.com/robust-python/cookiecutter-robust-python/issues)**
 
 ---
 
@@ -17,14 +17,14 @@ The only requirement is [uv].
 Navigate to where you want to create your project and run:
 
 ```bash
-uvx cruft create https://github.com/56kyle/cookiecutter-robust-python.git
+uvx cruft create https://github.com/robust-python/cookiecutter-robust-python.git
 ```
 
 This will prompt you for a few inputs to customize your project:
 ```
 [1/15] project_name (robust-python): my-awesome-project
-[2/15] package_name (my_awesome_project): 
-[3/15] friendly_name (My Awesome Project): 
+[2/15] package_name (my_awesome_project):
+[3/15] friendly_name (My Awesome Project):
 ...
 ```
 
@@ -60,7 +60,7 @@ uvx nox -s setup-remote
 For a general overview of where we are at with this template, please see the [roadmap](#roadmap) section.
 
 ## Example Output
-For an example of this template's output, please visit the [demo](https://github.com/56kyle/robust-python-demo) which is kept up to date with the current state of this template.
+For an example of this template's output, please visit the [demo](https://github.com/robust-python/robust-python-demo) which is kept up to date with the current state of this template.
 
 ## Roadmap
 
@@ -182,7 +182,7 @@ of trusted individuals to ensure the project is taken care of.
 [bitbucket-pipelines]: https://support.atlassian.com/bitbucket-cloud/docs/write-a-pipe-for-bitbucket-pipelines/
 [cookiecutter]: https://cookiecutter.readthedocs.io/en/stable/
 [cookiecutter-hypermodern-python]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
-[cookiecutter-robust-python]: https://github.com/56kyle/cookiecutter-robust-python
+[cookiecutter-robust-python]: https://github.com/robust-python/cookiecutter-robust-python
 [cruft]: https://cruft.github.io/cruft/
 [github]: https://github.com
 [github-actions]: https://docs.github.com/en/actions
@@ -193,11 +193,11 @@ of trusted individuals to ensure the project is taken care of.
 [monorepos]: https://en.wikipedia.org/wiki/Monorepo
 [my personal fork]: https://github.com/56kyle/cookiecutter-hypermodern-python
 [nox]: https://nox.thea.codes/
-[noxfile]: https://github.com/56kyle/cookiecutter-robust-python/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/noxfile.py
+[noxfile]: https://github.com/robust-python/cookiecutter-robust-python/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/noxfile.py
 [poetry]: https://python-poetry.org/docs/
 [polars]: https://github.com/pola-rs/polars
 [python]: https://www.python.org/
-[robust python cookiecutter]: https://github.com/56kyle/cookiecutter-robust-python
+[robust python cookiecutter]: https://github.com/robust-python/cookiecutter-robust-python
 [ruff]: https://docs.astral.sh/ruff/
 [rust]: https://www.rust-lang.org/learn
 [rye]: https://rye.astral.sh/
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -1,15 +1,15 @@
 {
-  "project_name": "robust-python",
+  "project_name": "robust-python-demo",
   "package_name": "{{ cookiecutter.project_name.replace('-', '_') }}",
   "friendly_name": "{{ cookiecutter.project_name.replace('-', ' ').title() }}",
   "min_python_version": "3.9",
   "max_python_version": "3.13",
   "add_rust_extension": false,
-  "author": "Kyle Oliver",
-  "email": "56kyleoliver+cookiecutter-robust-python@gmail.com",
+  "author": "First Last",
+  "email": "cookiecutter.robust.python@gmail.com",
   "repository_provider": ["github", "gitlab", "bitbucket"],
   "repository_host": "{% if cookiecutter.repository_provider == 'github' %}github.com{% elif cookiecutter.repository_provider == 'gitlab' %}gitlab.com{% else %}bitbucket.org{% endif %}",
-  "repository_path": "56kyle/{{ cookiecutter.project_name.replace('_', '-') }}",
+  "repository_path": "robust-python/{{ cookiecutter.project_name.replace('_', '-') }}",
   "version": "0.0.0",
   "copyright_year": "{% now 'utc', '%Y' %}",
   "license": ["MIT", "Apache-2.0", "GPL-3.0"],
diff --git a/docs/conf.py b/docs/conf.py
@@ -132,12 +132,12 @@
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/56kyle/cookiecutter-robust-python",
+            "url": "https://github.com/robust-python/cookiecutter-robust-python",
             "html": "<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 16 16'><path fill-rule='evenodd' d='M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.22.82.69 1.19 1.81.85 2.23.65.07-.51.28-.85.54-1.04-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38C13.71 14.53 16 11.53 16 8c0-4.42-3.58-8-8-8z'></path></svg>",
             "aria-label": "GitHub",
         },
     ],
-    "source_repository": "https://github.com/56kyle/cookiecutter-robust-python/",
+    "source_repository": "https://github.com/robust-python/cookiecutter-robust-python/",
     "source_branch": "main",
     "source_directory": "docs/",
 }
diff --git a/docs/getting-started-template-contributing.md b/docs/getting-started-template-contributing.md
@@ -17,7 +17,7 @@ To contribute to the template, you will need:
 1.  **Clone the Template Repository:**
 
     ```bash
-    git clone https://github.com/56kyle/cookiecutter-robust-python.git
+    git clone https://github.com/robust-python/cookiecutter-robust-python.git
     cd cookiecutter-robust-python
     ```
 
diff --git a/docs/maintenance.md b/docs/maintenance.md
@@ -15,13 +15,36 @@ The template's `pyproject.toml` file at the **template repository root** lists t
 To set up your environment for working _on the template_, clone the repository and install its dependencies:
 
 ```bash
-git clone https://github.com/56kyle/cookiecutter-robust-python.git # **UPDATE WITH TEMPLATE REPO URL**
+git clone https://github.com/robust-python/cookiecutter-robust-python.git # **UPDATE WITH TEMPLATE REPO URL**
 cd cookiecutter-robust-python
 uv sync # This installs deps from the template's pyproject.toml into a .venv for template dev
 ```
 
 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.
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -26,7 +26,7 @@ cd ~/path/to/my/repos
 Generate your project from the template:
 
 ```bash
-uvx cruft create https://github.com/56kyle/cookiecutter-robust-python.git
+uvx cruft create https://github.com/robust-python/cookiecutter-robust-python.git
 ```
 
 Follow the prompts to customize your project.
diff --git a/noxfile.py b/noxfile.py
@@ -1,10 +1,16 @@
 """Noxfile for the cookiecutter-robust-python template."""
+
+# /// script
+# dependencies = ["nox>=2025.5.1", "platformdirs>=4.3.8", "python-dotenv>=1.0.0"]
+# ///
+
 import os
 import shutil
 from pathlib import Path
 
 import nox
 import platformdirs
+from dotenv import load_dotenv
 from nox.command import CommandFailed
 from nox.sessions import Session
 
@@ -18,10 +24,21 @@
 TEMPLATE_FOLDER: Path = REPO_ROOT / "{{cookiecutter.project_name}}"
 
 
+# Load environment variables from .env and .env.local (if present)
+LOCAL_ENV_FILE: Path = REPO_ROOT / ".env.local"
+DEFAULT_ENV_FILE: Path = REPO_ROOT / ".env"
+
+if LOCAL_ENV_FILE.exists():
+    load_dotenv(LOCAL_ENV_FILE)
+
+if DEFAULT_ENV_FILE.exists():
+    load_dotenv(DEFAULT_ENV_FILE)
+
+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()
@@ -48,7 +65,7 @@
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="generate-demo")
 def generate_demo(session: Session) -> None:
     """Generates a project demo using the cookiecutter-robust-python template."""
-    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "typer")
+    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "python-dotenv", "typer")
     session.run("python", GENERATE_DEMO_SCRIPT, *GENERATE_DEMO_OPTIONS, *session.posargs)
 
 
@@ -126,7 +143,7 @@ def test(session: Session) -> None:
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="update-demo")
 def update_demo(session: Session, add_rust_extension: bool) -> None:
     session.log("Installing script dependencies for updating generated project demos...")
-    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "typer")
+    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "python-dotenv", "typer")
 
     session.log("Updating generated project demos...")
     args: list[str] = [*UPDATE_DEMO_OPTIONS]
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ dependencies = [
     "gitpython>=3.1.44",
     "loguru>=0.7.3",
     "platformdirs>=4.3.8",
+    "python-dotenv>=1.0.0",
     "retrocookie>=0.4.3",
     "typer>=0.15.4",
 ]
diff --git a/scripts/generate-demo.py b/scripts/generate-demo.py
@@ -18,7 +18,7 @@ def main(
     add_rust_extension: Annotated[bool, typer.Option("--add-rust-extension", "-r")] = False,
     no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False
 ) -> None:
-    """Updates the poetry.lock file."""
+    """Generates a project demo using the cookiecutter-robust-python template."""
     try:
         generate_demo(
             demos_cache_folder=demos_cache_folder,
diff --git a/scripts/lint-from-demo.py b/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__':
diff --git a/scripts/update-demo.py b/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,
diff --git a/scripts/util.py b/scripts/util.py
diff --git a/uv.lock b/uv.lock
diff --git a/{{cookiecutter.project_name}}/CODE_OF_CONDUCT.md b/{{cookiecutter.project_name}}/CODE_OF_CONDUCT.md
diff --git a/{{cookiecutter.project_name}}/CONTRIBUTING.md b/{{cookiecutter.project_name}}/CONTRIBUTING.md
diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md
diff --git a/{{cookiecutter.project_name}}/scripts/setup-git.py b/{{cookiecutter.project_name}}/scripts/setup-git.py
diff --git a/{{cookiecutter.project_name}}/scripts/setup-remote.py b/{{cookiecutter.project_name}}/scripts/setup-remote.py
