Merge pull request #10 from 56kyle/develop

General Project Lifecycle Fixes

Author: 56kyle

.editorconfig

@@ -0,0 +1,113 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 120
+tab_width = 4
+ij_continuation_indent_size = 8
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = true
+ij_smart_tabs = false
+ij_visual_guides =
+ij_wrap_on_typing = false
+
+[*.toml]
+indent_style = space
+indent_size = 4
+
+[*.yml,yaml,json]
+indent_style = space
+indent_size = 2
+
+[{*.py,*.pyw,*.whl}]
+indent_style = space
+indent_size = 4
+ij_continuation_indent_size = 4
+ij_python_add_indent_inside_injections = false
+ij_python_align_collections_and_comprehensions = true
+ij_python_align_multiline_imports = true
+ij_python_align_multiline_parameters = false
+ij_python_align_multiline_parameters_in_calls = false
+ij_python_blank_line_at_file_end = true
+ij_python_blank_lines_after_imports = 2
+ij_python_blank_lines_after_local_imports = 0
+ij_python_blank_lines_around_class = 1
+ij_python_blank_lines_around_method = 1
+ij_python_blank_lines_around_top_level_classes_functions = 2
+ij_python_blank_lines_before_first_method = 0
+ij_python_call_parameters_new_line_after_left_paren = true
+ij_python_call_parameters_right_paren_on_new_line = true
+ij_python_call_parameters_wrap = on_every_item
+ij_python_dict_alignment = 0
+ij_python_dict_new_line_after_left_brace = true
+ij_python_dict_new_line_before_right_brace = true
+ij_python_dict_wrapping = on_every_item
+ij_python_format_injected_fragments = true
+ij_python_from_import_new_line_after_left_parenthesis = true
+ij_python_from_import_new_line_before_right_parenthesis = true
+ij_python_from_import_parentheses_force_if_multiline = true
+ij_python_from_import_trailing_comma_if_multiline = false
+ij_python_from_import_wrapping = on_every_item
+ij_python_hang_closing_brackets = false
+ij_python_keep_blank_lines_in_code = 1
+ij_python_keep_blank_lines_in_declarations = 1
+ij_python_keep_indents_on_empty_lines = false
+ij_python_keep_line_breaks = true
+ij_python_list_new_line_after_left_bracket = true
+ij_python_list_new_line_before_right_bracket = true
+ij_python_list_wrapping = on_every_item
+ij_python_method_parameters_new_line_after_left_paren = true
+ij_python_method_parameters_right_paren_on_new_line = true
+ij_python_method_parameters_wrap = on_every_item
+ij_python_new_line_after_colon = true
+ij_python_new_line_after_colon_multi_clause = true
+ij_python_optimize_imports_always_split_from_imports = true
+ij_python_optimize_imports_case_insensitive_order = false
+ij_python_optimize_imports_join_from_imports_with_same_source = false
+ij_python_optimize_imports_sort_by_type_first = true
+ij_python_optimize_imports_sort_imports = true
+ij_python_optimize_imports_sort_names_in_from_imports = false
+ij_python_set_new_line_after_left_brace = true
+ij_python_set_new_line_before_right_brace = true
+ij_python_set_wrapping = on_every_item
+ij_python_space_after_comma = true
+ij_python_space_after_number_sign = true
+ij_python_space_after_py_colon = true
+ij_python_space_before_backslash = true
+ij_python_space_before_comma = false
+ij_python_space_before_for_semicolon = false
+ij_python_space_before_lbracket = false
+ij_python_space_before_method_call_parentheses = false
+ij_python_space_before_method_parentheses = false
+ij_python_space_before_number_sign = true
+ij_python_space_before_py_colon = false
+ij_python_space_within_empty_method_call_parentheses = false
+ij_python_space_within_empty_method_parentheses = false
+ij_python_spaces_around_additive_operators = true
+ij_python_spaces_around_assignment_operators = true
+ij_python_spaces_around_bitwise_operators = true
+ij_python_spaces_around_eq_in_keyword_argument = false
+ij_python_spaces_around_eq_in_named_parameter = false
+ij_python_spaces_around_equality_operators = true
+ij_python_spaces_around_multiplicative_operators = true
+ij_python_spaces_around_power_operator = true
+ij_python_spaces_around_relational_operators = true
+ij_python_spaces_around_shift_operators = true
+ij_python_spaces_within_braces = false
+ij_python_spaces_within_brackets = false
+ij_python_spaces_within_method_call_parentheses = false
+ij_python_spaces_within_method_parentheses = false
+ij_python_tuple_new_line_after_left_parenthesis = true
+ij_python_tuple_new_line_before_right_parenthesis = true
+ij_python_tuple_wrapping = on_every_item
+ij_python_use_continuation_indent_for_arguments = false
+ij_python_use_continuation_indent_for_collection_and_comprehensions = false
+ij_python_use_continuation_indent_for_parameters = true
+ij_python_use_trailing_comma_in_arguments_list = false
+ij_python_use_trailing_comma_in_collections = false
+ij_python_use_trailing_comma_in_parameter_list = false
+ij_python_wrap_long_lines = false

.gitignore

@@ -61,5 +61,4 @@ Thumbs.db      # Windows thumbnail cache
 debug.log
 nohup.out
 
-# Cookiecutter/Cruft metadata (for template updates)
-.cruft.json
+/.idea/

README.md

@@ -12,10 +12,10 @@ Any and all advice, support, PR's, etc are welcome and would be greatly apprecia
 
 
 # Why does this project exist?
-Unfortunately the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.
+Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.
 While it will always have a place in my heart, there have been far too many improvements in Python tooling to keep using it as is.
 
-For a whle I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however when it came time to switch
+For a while I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however when it came time to switch
 to new tooling such as [ruff], [uv], [maturin], etc, I found the process of updating the existing tooling to be extremly painful.
 
 The [Hypermodern Python Cookiecutter] remains as a fantastic sendoff point for devs interested in building a 2021 style Python Package, but there were
@@ -34,7 +34,7 @@ The [Robust Python Cookiecutter] exists to solve a few main concerns
 One of the main issues I encountered with [my personal fork] of the [Hypermodern Python Cookiecutter] was that any change
 I made to my repos would mean a later conflict if I tried to rerun [cookiecutter] to sync a change from a different project.
 
-Thankfully [cruft] exists specifically to help with this issue. It enables us to periodically create PR's to add in any fixes
+Thankfully, [cruft] exists specifically to help with this issue. It enables us to periodically create PR's to add in any fixes
 the [Robust Python Cookiecutter] may have added.
 
 Additionally, extra care is put in to use tooling specific config files whenever possible to help reduce merge conflicts occurring
@@ -76,12 +76,12 @@ Overall it's rather rare that people debate over tooling for no reason. Most thi
 
 ## CI/CD Vendor Lock
 Now don't get me wrong, I love [github-actions] and do pretty much everything in my power to avoid [bitbucket-pipelines].
-However not all jobs have the luxury of github, and I would love to be able to just use the same template for both my personal and professional projects.
+However, not all jobs have the luxury of github, and I would love to be able to just use the same template for both my personal and professional projects.
 
 The [Robust Python Cookiecutter] focuses on being as modular as possible for areas that connect to the CI/CD pipeline. Additionally, there will always be either alternative
 CI/CD options or at a minimum basic examples of what the translated CI/CD pipeline would look like.
 
-Finally the main reason that this task is even possible is that the [Robust Python Cookiecutter] mirrors all of the CI/CD steps in it's local dev tooling.
+Finally, the main reason that this task is even possible is that the [Robust Python Cookiecutter] mirrors all of the CI/CD steps in it's local dev tooling.
 The local [noxfile] is designed to match up directly with the CI/CD each step of the way.
 
 The [Hypermodern Python Cookiecutter] did this where it could afford to also, however the lack of [uv] meant it would significantly increase CI/CD times if done everywhere.

noxfile.py

@@ -155,10 +155,10 @@ def docs(session: Session):
 
     session.log(f"Cleaning template docs build directory: {docs_build_dir}")
     docs_build_dir.parent.mkdir(parents=True, exist_ok=True)
-    session.run("uv", "run", "sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-E", external=True)
+    session.run("sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-E")
 
     session.log("Building template documentation.")
-    session.run("uv", "run", "sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-W", external=True)
+    session.run("sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-W")
 
     session.log(f"Template documentation built in {docs_build_dir.resolve()}.")
 
@@ -199,7 +199,7 @@ def test(session: Session) -> None:
     session.install("-e", ".", external=True)
 
     session.log("Running generated project's default checks...")
-    session.run("uv", "run", "nox", external=True)
+    session.run("nox")
 
     session.log(f"Cleaning up temporary directory: {temp_dir}")
     shutil.rmtree(temp_dir)
@@ -221,7 +221,7 @@ def release_template(session: Session):
         session.skip("Git not available.")
 
     session.log("Checking Commitizen availability via uvx.")
-    session.run("uvx", "cz", "--version", successcodes=[0], external=True)
+    session.run("cz", "--version", successcodes=[0])
 
     increment = session.posargs[0] if session.posargs else None
     session.log(

pyproject.toml

@@ -10,12 +10,12 @@ dependencies = [
     "loguru>=0.7.3",
     "platformdirs>=4.3.8",
     "retrocookie>=0.4.3",
-    "typer>=0.15.3",
+    "typer>=0.15.4",
 ]
 
 [dependency-groups]
 dev = [
-    "commitizen>=4.7.0",
+    "commitizen>=4.8.2",
     "nox>=2025.5.1",
     "pre-commit>=4.2.0",
 ]

uv.lock

@@ -11,6 +11,8 @@ write_version_files = [
     "src/{{ cookiecutter.package_name }}/__init__.py:__version__",
 ]
 commit_msg_file = ".git/COMMIT_EDITMSG"
+retry_after_failure = true
+update_changelog_on_bump = true
 
 [tool.commitizen.github]
 release = true

{{cookiecutter.project_name}}/.cz.toml

@@ -5,11 +5,109 @@ charset = utf-8
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+max_line_length = 120
+tab_width = 4
+ij_continuation_indent_size = 8
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = true
+ij_smart_tabs = false
+ij_visual_guides =
+ij_wrap_on_typing = false
 
-[*.{py,toml}]
+[*.toml]
 indent_style = space
 indent_size = 4
 
 [*.yml,yaml,json]
 indent_style = space
 indent_size = 2
+
+[{*.py,*.pyw,*.whl}]
+indent_style = space
+indent_size = 4
+ij_continuation_indent_size = 4
+ij_python_add_indent_inside_injections = false
+ij_python_align_collections_and_comprehensions = true
+ij_python_align_multiline_imports = true
+ij_python_align_multiline_parameters = false
+ij_python_align_multiline_parameters_in_calls = false
+ij_python_blank_line_at_file_end = true
+ij_python_blank_lines_after_imports = 2
+ij_python_blank_lines_after_local_imports = 0
+ij_python_blank_lines_around_class = 1
+ij_python_blank_lines_around_method = 1
+ij_python_blank_lines_around_top_level_classes_functions = 2
+ij_python_blank_lines_before_first_method = 0
+ij_python_call_parameters_new_line_after_left_paren = true
+ij_python_call_parameters_right_paren_on_new_line = true
+ij_python_call_parameters_wrap = on_every_item
+ij_python_dict_alignment = 0
+ij_python_dict_new_line_after_left_brace = true
+ij_python_dict_new_line_before_right_brace = true
+ij_python_dict_wrapping = on_every_item
+ij_python_format_injected_fragments = true
+ij_python_from_import_new_line_after_left_parenthesis = true
+ij_python_from_import_new_line_before_right_parenthesis = true
+ij_python_from_import_parentheses_force_if_multiline = true
+ij_python_from_import_trailing_comma_if_multiline = false
+ij_python_from_import_wrapping = on_every_item
+ij_python_hang_closing_brackets = false
+ij_python_keep_blank_lines_in_code = 1
+ij_python_keep_blank_lines_in_declarations = 1
+ij_python_keep_indents_on_empty_lines = false
+ij_python_keep_line_breaks = true
+ij_python_list_new_line_after_left_bracket = true
+ij_python_list_new_line_before_right_bracket = true
+ij_python_list_wrapping = on_every_item
+ij_python_method_parameters_new_line_after_left_paren = true
+ij_python_method_parameters_right_paren_on_new_line = true
+ij_python_method_parameters_wrap = on_every_item
+ij_python_new_line_after_colon = true
+ij_python_new_line_after_colon_multi_clause = true
+ij_python_optimize_imports_always_split_from_imports = true
+ij_python_optimize_imports_case_insensitive_order = false
+ij_python_optimize_imports_join_from_imports_with_same_source = false
+ij_python_optimize_imports_sort_by_type_first = true
+ij_python_optimize_imports_sort_imports = true
+ij_python_optimize_imports_sort_names_in_from_imports = false
+ij_python_set_new_line_after_left_brace = true
+ij_python_set_new_line_before_right_brace = true
+ij_python_set_wrapping = on_every_item
+ij_python_space_after_comma = true
+ij_python_space_after_number_sign = true
+ij_python_space_after_py_colon = true
+ij_python_space_before_backslash = true
+ij_python_space_before_comma = false
+ij_python_space_before_for_semicolon = false
+ij_python_space_before_lbracket = false
+ij_python_space_before_method_call_parentheses = false
+ij_python_space_before_method_parentheses = false
+ij_python_space_before_number_sign = true
+ij_python_space_before_py_colon = false
+ij_python_space_within_empty_method_call_parentheses = false
+ij_python_space_within_empty_method_parentheses = false
+ij_python_spaces_around_additive_operators = true
+ij_python_spaces_around_assignment_operators = true
+ij_python_spaces_around_bitwise_operators = true
+ij_python_spaces_around_eq_in_keyword_argument = false
+ij_python_spaces_around_eq_in_named_parameter = false
+ij_python_spaces_around_equality_operators = true
+ij_python_spaces_around_multiplicative_operators = true
+ij_python_spaces_around_power_operator = true
+ij_python_spaces_around_relational_operators = true
+ij_python_spaces_around_shift_operators = true
+ij_python_spaces_within_braces = false
+ij_python_spaces_within_brackets = false
+ij_python_spaces_within_method_call_parentheses = false
+ij_python_spaces_within_method_parentheses = false
+ij_python_tuple_new_line_after_left_parenthesis = true
+ij_python_tuple_new_line_before_right_parenthesis = true
+ij_python_tuple_wrapping = on_every_item
+ij_python_use_continuation_indent_for_arguments = false
+ij_python_use_continuation_indent_for_collection_and_comprehensions = false
+ij_python_use_continuation_indent_for_parameters = true
+ij_python_use_trailing_comma_in_arguments_list = false
+ij_python_use_trailing_comma_in_collections = false
+ij_python_use_trailing_comma_in_parameter_list = false
+ij_python_wrap_long_lines = false