Merge pull request #55 from pythoninthegrass/copier

ci: Convert to copier

Author: pythoninthegrass

.copier/.copier-answers.yml.j2

@@ -0,0 +1 @@
+{{ _copier_answers|to_json -}}

.copier/update_dotenv.py

@@ -1,56 +1,29 @@
-#!/usr/bin/env python3
-"""
-This script updates the .env file with values from the Copier answers.
-It allows the .env file to be a regular file (not a template) that works with or without Copier.
-"""
-
-from pathlib import Path
 import json
-import yaml
+from pathlib import Path
 
 # Update the .env file with the answers from the .copier-answers.yml file
 # without using Jinja2 templates in the .env file, this way the code works as is
 # without needing Copier, but if Copier is used, the .env file will be updated
 root_path = Path(__file__).parent.parent
-answers_path = root_path / ".copier-answers.yml"
-
-# Load the answers from YAML format
-with open(answers_path, "r") as f:
-    answers_yaml = f.read()
-    # Convert YAML to Python dict
-    answers = yaml.safe_load(answers_yaml)
-
+answers_path = Path(__file__).parent / ".copier-answers.yml"
+answers = json.loads(answers_path.read_text())
 env_path = root_path / ".env"
-if not env_path.exists():
-    env_example_path = root_path / ".env.example"
-    if env_example_path.exists():
-        with open(env_example_path, "r") as f:
-            env_content = f.read()
-    else:
-        env_content = ""
-else:
-    with open(env_path, "r") as f:
-        env_content = f.read()
+env_content = env_path.read_text()
 
-# Update the .env file
 lines = []
+
 for line in env_content.splitlines():
-    line_updated = False
     for key, value in answers.items():
         upper_key = key.upper()
         if line.startswith(f"{upper_key}="):
-            if isinstance(value, str) and " " in value:
-                content = f'{upper_key}="{value}"'
+            if " " in value:
+                content = f"{upper_key}={value!r}"
             else:
                 content = f"{upper_key}={value}"
-            lines.append(content)
-            line_updated = True
+            new_line = line.replace(line, content)
+            lines.append(new_line)
             break
-    if not line_updated:
+    else:
         lines.append(line)
 
-# Write the updated .env file
-with open(env_path, "w") as f:
-    f.write("\n".join(lines))
-
-print(f"Updated {env_path} with values from Copier answers.")
+env_path.write_text("\n".join(lines))

.env.example

@@ -323,4 +323,4 @@ Temporary Items
 
 # INCLUDE
 !**/.gitkeep
-!**/*.example
+!**/*.example*

.gitignore

@@ -56,35 +56,43 @@ devbox run test
 ### Taskfile
 ```bash
 λ task
+task: [default] task --list
 task: Available tasks for this project:
-* checkbash:                Check bash scripts
-* default:                  Default task
-* format:                   Run formatters
-* install:                  Install project dependencies
-* install-devbox:           Install devbox
-* lint:                     Run linters
-* pre-commit:               Run pre-commit hooks
-* pyclean:                  Remove .pyc and __pycache__
-* test:                     Run tests
-* docker:build:             Build the docker image                                                     (aliases: docker:build)
-* docker:down:              Stop and remove containers, networks, and volumes with docker compose      (aliases: docker:down)
-* docker:exec:              Shell into a running container                                             (aliases: docker:exec)
-* docker:login:             Login to the container registry                                            (aliases: docker:login)
-* docker:logs:              Follow the logs of a running container                                     (aliases: docker:logs)
-* docker:net:               Create docker network                                                      (aliases: docker:net)
-* docker:prune:             Prune docker                                                               (aliases: docker:prune)
-* docker:push:              Push the docker image to the registry                                      (aliases: docker:push)
-* docker:stop:              Stop the project with docker compose                                       (aliases: docker:stop)
-* docker:up:                Start the project with docker compose                                      (aliases: docker:up)
-* docker:vol:               Create docker volume                                                       (aliases: docker:vol)
-* poetry:add-pypi:          Add test-pypi repository                                                   (aliases: poetry:add-pypi)
-* poetry:build:             Build the poetry bin                                                       (aliases: poetry:build)
-* poetry:bump-semver:       Bump the project semantic version                                          (aliases: poetry:bump-semver)
-* poetry:default:           Default task                                                               (aliases: poetry:default, poetry, poetry)
-* poetry:export-reqs:       Export requirements.txt                                                    (aliases: poetry:export-reqs)
-* poetry:install:           Install project dependencies                                               (aliases: poetry:install)
-* poetry:publish:           Publish the poetry bin                                                     (aliases: poetry:publish)
-* poetry:update-deps:       Update dependencies                                                        (aliases: poetry:update-deps)
+* default:               Default task
+* format:                Run formatters
+* install:               Install project dependencies
+* install-devbox:        Install devbox
+* lint:                  Run linters
+* pre-commit:            Run pre-commit hooks
+* pyclean:               Remove .pyc and __pycache__
+* test:                  Run tests
+* docker:build:          Build the docker image
+* docker:down:           Stop and remove containers, networks, and volumes with docker compose
+* docker:exec:           Shell into a running container
+* docker:login:          Login to the container registry
+* docker:logs:           Follow the logs of a running container
+* docker:net:            Create docker network
+* docker:prune:          Prune docker
+* docker:push:           Push the docker image to the registry
+* docker:stop:           Stop the project with docker compose
+* docker:up:             Start the project with docker compose
+* docker:vol:            Create docker volume
+* orbstack:create:       Create an orbstack VM        (aliases: orb:create)
+* orbstack:delete:       Delete an orbstack VM        (aliases: orb:delete)
+* orbstack:exec:         SSH into an orbstack VM      (aliases: orb:exec)
+* orbstack:list:         List orbstack VMs            (aliases: orb:list)
+* orbstack:start:        Start an orbstack VM         (aliases: orb:start)
+* orbstack:stop:         Stop an orbstack VM          (aliases: orb:stop)
+* orbstack:update:       Update orbstack app          (aliases: orb:update)
+* redis:start:           Start Redis server
+* redis:stop:            Stop Redis server
+* uv:export-reqs:        Export requirements.txt
+* uv:install:            Install project dependencies
+* uv:install-uv:         Install uv
+* uv:lock:               Update the project's lockfile.
+* uv:sync:               Sync dependencies with lockfile
+* uv:update-deps:        Update dependencies
+* uv:venv:               Create a virtual environment                                                    
 ```
 
 ### Tilt

README.md

@@ -13,6 +13,9 @@ _jinja_extensions:
 - extensions.py:SlugifyExtension
 _skip_if_exists:
 - CHANGELOG.md
+_answers_file: .copier/.copier-answers.yml
+_tasks:
+  - ["{{ _copier_python }}", .copier/update_dotenv.py]
 
 # PROMPT --------------------------------
 project_name:
@@ -22,7 +25,6 @@ project_name:
 project_description:
   type: str
   help: Your project description
-  default: "Minimum Viable Python Template"
 
 author_fullname:
   type: str
@@ -37,7 +39,6 @@ author_email:
 author_username:
   type: str
   help: Your username (e.g. on GitHub)
-  default: "pythoninthegrass"
 
 repository_provider:
   type: str
@@ -46,7 +47,6 @@ repository_provider:
   choices:
   - github.com
   - gitlab.com
-  - bitbucket.org
 
 repository_namespace:
   type: str
@@ -78,39 +78,15 @@ copyright_license:
   help: Your project's license
   default: Unlicense
   choices:
-    Academic Free License v3.0: AFL-3.0
     Apache License 2.0: Apache-2.0
-    Artistic License 2.0: Artistic-2.0
-    BSD 2-Clause "Simplified" License: BSD-2-Clause
-    BSD 3-Clause Clear License: BSD-3-Clause-Clear
-    BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
-    Boost Software License 1.0: BSL-1.0
     Creative Commons Attribution 4.0 International: CC-BY-4.0
-    Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
     Creative Commons Zero v1.0 Universal: CC0-1.0
     Do What The F*ck You Want To Public License: WTFPL
-    Educational Community License v2.0: ECL-2.0
-    Eclipse Public License 1.0: EPL-1.0
-    Eclipse Public License 2.0: EPL-2.0
-    European Union Public License 1.1: EUPL-1.1
-    European Union Public License 1.2: EUPL-1.2
     GNU Affero General Public License v3.0: AGPL-3.0
-    GNU General Public License v2.0 only: GPL-2.0
     GNU General Public License v3.0 only: GPL-3.0
-    GNU Lesser General Public License v2.1 only: LGPL-2.1
-    GNU Lesser General Public License v3.0 only: LGPL-3.0
-    ISC License: ISC
-    LaTeX Project Public License v1.3c: LPPL-1.3c
     MIT License: MIT
     Mozilla Public License 2.0: MPL-2.0
-    Microsoft Public License: MS-PL
-    Microsoft Reciprocal License: MS-RL
-    University of Illinois/NCSA Open Source License: NCSA
-    SIL Open Font License 1.1: OFL-1.1
-    Open Software License 3.0: OSL-3.0
-    PostgreSQL License: PostgreSQL
     The Unlicense: Unlicense
-    zlib License: Zlib
 
 python_package_distribution_name:
   type: str