Implement comprehensive template enhancements: hooks, typed config, package managers, SBOM, enhanced CI/CD

Co-authored-by: retr0crypticghost <139195952+retr0crypticghost@users.noreply.github.com>

Author: Copilot

cookiecutter.json

@@ -7,7 +7,12 @@
   "github_username": "your-username",
   "project_description": "A brief description of your project",
   "python_version": "3.11",
-  "project_type": ["library", "cli-application", "web-api", "data-science"],
+  "project_type": ["library", "cli-application"],
+  "package_manager": ["pip", "uv", "hatch"],
+  "docs": ["y", "n"],
+  "typed_config": ["n", "y"],
+  "sbom": ["n", "y"],
+  "versioning": ["setuptools-scm", "manual", "hatch"],
   "include_docker": "n",
   "include_github_actions": "y",
   "include_pre_commit": "y",

hooks/post_gen_project.py

@@ -29,9 +29,8 @@ def remove_directory(dirpath):
         print(f"Removed {dirpath}")
 
 
-def main():
-    """Main post-generation logic."""
-
+def cleanup_project_type():
+    """Handle project type specific cleanup."""
     project_type = "{{ cookiecutter.project_type }}"
 
     if project_type == "library":
@@ -42,6 +41,9 @@ def main():
         # Remove CLI module for library projects
         cli_module = "src/{{ cookiecutter.package_name }}/cli.py"
         remove_file(cli_module)
+        
+        # Remove CLI tests
+        remove_file("tests/test_cli.py")
 
         print("✅ Library project configured - removed CLI components")
 
@@ -52,6 +54,73 @@ def main():
     else:
         print(f"⚠️  Unknown project type: {project_type}")
 
+
+def cleanup_docs():
+    """Handle documentation cleanup based on docs option."""
+    docs_enabled = "{{ cookiecutter.docs }}" == "y"
+    
+    if not docs_enabled:
+        remove_file("mkdocs.yml")
+        remove_directory("docs")
+        
+        # Remove docs workflow
+        remove_file(".github/workflows/docs.yml")
+        
+        print("✅ Documentation disabled - removed MkDocs files")
+    else:
+        print("✅ Documentation enabled - kept MkDocs files")
+
+
+def cleanup_typed_config():
+    """Handle typed config cleanup."""
+    typed_config_enabled = "{{ cookiecutter.typed_config }}" == "y"
+    
+    if not typed_config_enabled:
+        # Remove Pydantic settings file if it exists
+        remove_file("src/{{ cookiecutter.package_name }}/settings.py")
+        print("✅ Typed config disabled - using standard config")
+    else:
+        print("✅ Typed config enabled - Pydantic settings available")
+
+
+def cleanup_sbom():
+    """Handle SBOM workflow cleanup."""
+    sbom_enabled = "{{ cookiecutter.sbom }}" == "y"
+    
+    if not sbom_enabled:
+        remove_file(".github/workflows/sbom.yml")
+        print("✅ SBOM generation disabled - removed workflow")
+    else:
+        print("✅ SBOM generation enabled - workflow available")
+
+
+def cleanup_versioning():
+    """Handle versioning cleanup based on versioning option."""
+    versioning = "{{ cookiecutter.versioning }}"
+    
+    if versioning == "manual":
+        # Remove versioning files for manual versioning
+        remove_file("_version.py")  # setuptools-scm version file
+        print("✅ Manual versioning configured")
+    elif versioning == "setuptools-scm":
+        print("✅ setuptools-scm versioning configured")
+    elif versioning == "hatch":
+        print("✅ Hatch versioning configured")
+
+
+def main():
+    """Main post-generation logic."""
+    print("🔧 Configuring generated project...")
+
+    # Handle different project types
+    cleanup_project_type()
+    
+    # Handle optional features
+    cleanup_docs()
+    cleanup_typed_config()
+    cleanup_sbom()
+    cleanup_versioning()
+
     print("✅ Project generation completed successfully!")
 
 

hooks/pre_gen_project.py

@@ -0,0 +1,137 @@
+#!/usr/bin/env python3
+"""
+Pre-generation hook for python-template cookiecutter.
+
+This script runs before the project is generated and validates
+the user inputs, ensuring they meet requirements.
+"""
+
+import re
+import sys
+from pathlib import Path
+
+
+def validate_package_name(package_name: str) -> bool:
+    """
+    Validate that package_name is a valid Python identifier.
+    
+    Args:
+        package_name: The package name to validate
+        
+    Returns:
+        bool: True if valid, False otherwise
+    """
+    # Check if it's a valid Python identifier
+    if not package_name.isidentifier():
+        return False
+    
+    # Check for Python keywords
+    import keyword
+    if keyword.iskeyword(package_name):
+        return False
+        
+    # Check for reserved names
+    reserved_names = {
+        'test', 'tests', 'lib', 'src', 'docs', 'examples', 'example',
+        'setup', 'build', 'dist', 'egg-info', '__pycache__'
+    }
+    if package_name.lower() in reserved_names:
+        return False
+    
+    return True
+
+
+def normalize_project_slug(project_slug: str) -> str:
+    """
+    Normalize project slug to follow best practices.
+    
+    Args:
+        project_slug: The project slug to normalize
+        
+    Returns:
+        str: Normalized project slug
+    """
+    # Convert to lowercase
+    slug = project_slug.lower()
+    
+    # Replace spaces and underscores with hyphens
+    slug = re.sub(r'[\s_]+', '-', slug)
+    
+    # Remove invalid characters
+    slug = re.sub(r'[^a-z0-9\-]', '', slug)
+    
+    # Remove leading/trailing hyphens and collapse multiple hyphens
+    slug = re.sub(r'-+', '-', slug).strip('-')
+    
+    return slug
+
+
+def validate_inputs():
+    """Validate all cookiecutter inputs."""
+    errors = []
+    
+    # Get cookiecutter variables
+    package_name = "{{ cookiecutter.package_name }}"
+    project_slug = "{{ cookiecutter.project_slug }}"
+    project_type = "{{ cookiecutter.project_type }}"
+    package_manager = "{{ cookiecutter.package_manager }}"
+    python_version = "{{ cookiecutter.python_version }}"
+    
+    # Validate package name
+    if not validate_package_name(package_name):
+        errors.append(f"❌ Invalid package_name '{package_name}': Must be a valid Python identifier")
+        errors.append("   - Cannot contain spaces, hyphens, or special characters")
+        errors.append("   - Cannot be a Python keyword")
+        errors.append("   - Cannot be a reserved name (test, tests, lib, src, etc.)")
+        
+    # Validate project type
+    valid_project_types = ["library", "cli-application"]
+    if project_type not in valid_project_types:
+        errors.append(f"❌ Invalid project_type '{project_type}': Must be one of {valid_project_types}")
+    
+    # Validate package manager
+    valid_package_managers = ["pip", "uv", "hatch"]
+    if package_manager not in valid_package_managers:
+        errors.append(f"❌ Invalid package_manager '{package_manager}': Must be one of {valid_package_managers}")
+    
+    # Validate Python version format
+    try:
+        version_parts = python_version.split('.')
+        if len(version_parts) != 2:
+            raise ValueError("Invalid format")
+        major, minor = int(version_parts[0]), int(version_parts[1])
+        if major != 3 or minor < 11:
+            errors.append(f"❌ Invalid python_version '{python_version}': Must be 3.11 or higher")
+    except ValueError:
+        errors.append(f"❌ Invalid python_version '{python_version}': Must be in format 'X.Y' (e.g., '3.11')")
+    
+    # Check for potential slug issues (warn but don't fail)
+    normalized_slug = normalize_project_slug(project_slug)
+    if project_slug != normalized_slug:
+        print(f"⚠️  Project slug '{project_slug}' would be normalized to '{normalized_slug}'")
+        print("   Consider using the normalized version for better compatibility")
+    
+    if errors:
+        print("🛑 Cookiecutter validation failed:")
+        print()
+        for error in errors:
+            print(error)
+        print()
+        print("💡 Tips:")
+        print("   - Use underscores for package_name: my_package")  
+        print("   - Use hyphens for project_slug: my-project")
+        print("   - Choose from supported project types: library, cli-application")
+        print("   - Choose from supported package managers: pip, uv, hatch")
+        sys.exit(1)
+    
+    print("✅ Input validation passed!")
+
+
+def main():
+    """Main pre-generation logic."""
+    print("🔍 Validating cookiecutter inputs...")
+    validate_inputs()
+
+
+if __name__ == "__main__":
+    main()