feat: add FastAPI template generation with all utilities (#88)

* feat: add FastAPI project template and configuration files

* feat: implement project generation command with framework validation

* feat: add cloud storage support with AWS S3 integration and helper functions

* fix: update template path resolution in generate.py

* feat: update README template for FastAPI project commands and usage

* feat: add Google Cloud Storage support with GCP integration and configuration

* feat: add database support with async SQLAlchemy integration and session management

* feat: add database support with async SQLAlchemy integration and session management

* feat: add testing framework with async fixtures and integration tests for FastAPI

* feat: update testing setup and add CLI testing script for FastAPI project

* feat: update testing setup and add CLI testing script for FastAPI project

* feat: update testing setup and add CLI testing script for FastAPI project

* feat: add Azure Blob Storage support with configuration and service implementation

* feat: add Azure Blob Storage support with configuration and service implementation

* feat: add Azure Storage support to project initialization

Author: pythonhubdev

.github/workflows/ci.yml

@@ -52,6 +52,3 @@ jobs:
 
             -   name: Type check
                 run: uv run basedpyright .
-
-            -   name: Run MyPy
-                run: uv run mypy . --install-types --non-interactive

.gitignore

@@ -291,3 +291,4 @@ opencode.json
 # END Ruler Generated Files
 
 .cache_ggshield
+!.env.jinja

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
-#    -   hooks:
-#            -   always_run: true
-#                entry: .hooks/branch
-#                id: branch-naming
-#                language: script
-#                name: Branch naming convention check
-#                stages:
-#                    - pre-commit
-#        repo: local
+    -   hooks:
+            -   always_run: true
+                entry: .hooks/branch
+                id: branch-naming
+                language: script
+                name: Branch naming convention check
+                stages:
+                    - pre-commit
+        repo: local
     -   hooks:
             -   id: check-ast
                 language_version: python3.13
@@ -17,11 +17,12 @@ repos:
                 id: check-yaml
             -   id: check-toml
             -   args:
-#                    - --branch
-#                    - main
+                    - --branch
+                    - main
                     - --branch
                     - master
                 id: no-commit-to-branch
+
         repo: https://github.com/pre-commit/pre-commit-hooks
         rev: v6.0.0
     -   hooks:
@@ -32,6 +33,7 @@ repos:
             -   args:
                     - --py313-plus
                 id: pyupgrade
+
         repo: https://github.com/asottile/pyupgrade
         rev: v3.20.0
     -   hooks:
@@ -44,18 +46,15 @@ repos:
                     - python
         repo: local
     -   hooks:
-            -   entry: uv run ruff check
+            -   entry: uv run ruff check src
                 id: lint
                 language: system
                 name: lint
                 require_serial: true
                 types:
                     - python
         repo: local
-    -   hooks:
-            -   id: mypy
-        repo: https://github.com/pre-commit/mirrors-mypy
-        rev: v1.18.2
+
     -   hooks:
             -   entry: uv run basedpyright
                 id: pyright

README.md

@@ -58,10 +58,6 @@ scaffoldr generate my-api
 
 # Generate with specific framework
 scaffoldr generate my-api --framework fastapi
-scaffoldr generate my-flask-app --framework flask
-
-# Generate with additional options
-scaffoldr generate my-project --framework fastapi --database postgres --auth jwt
 
 # Get help
 scaffoldr --help
@@ -71,6 +67,21 @@ scaffoldr generate --help
 scaffoldr --no-banner generate my-project
 ```
 
+### Generated Project Features
+
+When you generate a FastAPI project, you get:
+
+- **Complete FastAPI Application**: Pre-configured with proper structure
+- **Database Integration**: SQLAlchemy with Alembic migrations
+- **File Storage**: Built-in file upload/download endpoints
+- **API Documentation**: Auto-generated OpenAPI/Swagger docs
+- **Development Tools**: Pre-configured with ruff, mypy, pytest
+- **Docker Support**: Ready-to-use Docker configuration
+- **Environment Management**: .env support with validation
+- **Logging**: Structured logging with proper middleware
+- **Error Handling**: Comprehensive exception handling
+- **Testing**: Test structure with fixtures and examples
+
 ### ✨ Animated Banner
 
 Scaffoldr features a beautiful animated ASCII banner with rainbow wave effects that displays when you run the CLI! The

pyproject.toml

@@ -22,6 +22,7 @@ dependencies = [
 	"typer>=0.19.2",
 	"uv-build>=0.8.22",
 	"rich>=13.7.0",
+	"copier>=9.10.2",
 ]
 
 [dependency-groups]
@@ -55,6 +56,9 @@ build-backend = "uv_build"
 
 [tool.mypy]
 mypy_path = ["src"]
+exclude = [
+	"src/scaffoldr/templates/.*",
+]
 namespace_packages = true
 explicit_package_bases = true
 

pyrightconfig.json

@@ -8,7 +8,8 @@
 		"**/__pycache__",
 		"dist",
 		"build",
-		".git"
+		".git",
+		"templates"
 	],
 	"defineConstant": {
 		"DEBUG": true
@@ -20,5 +21,6 @@
 	"pythonPlatform": "All",
 	"useLibraryCodeForTypes": true,
 	"autoImportCompletions": true,
-	"reportUnusedCallResult": false
+	"reportUnusedCallResult": false,
+	"reportImplicitStringConcatenation": false
 }

ruff.toml

@@ -0,0 +1,106 @@
+fix = true
+line-length = 100
+target-version = "py313"
+indent-width = 4
+exclude = [".venv", "/templates"]
+
+[format]
+docstring-code-format = true
+docstring-code-line-length = 100
+indent-style = "tab"
+quote-style = "double"
+skip-magic-trailing-comma = false
+
+[lint]
+exclude = ["migrations/versions/*", ".venv"]
+ignore = [
+	"E712", # equality comparison messes with SQL
+	"RUF003", # quotes in comment
+	"B006", # mutable default arguments like []
+	"ANN401", # don't allow Any as type
+	"UP033", # prefer e!s
+	"S311", # no random generators
+	"D200", # one line docstring one line
+	"RUF006", # store ref to create_task
+	"G004", # logging statement uses f string
+	"PERF203", # try except in loop
+	"ANN003", # kwargs type annotation
+	"EM101", # string literal
+	"SIM103", # return condition directly
+	"RET504", # assignment before return
+	"D205", # docstring rules
+	"C901", # too complex names for functions
+	"PERF401", # do not use .append()
+	"PERF102", # no _ with .items()
+	"EM102", # F string in exception
+	"FBT001", # Boolean default args
+	"FBT002", # Boolean default args
+	"ANN201", # Return type
+	"D400", # Docstring period
+	"D415", # Docstring
+	"E722", # Bare except
+	"D401", # Imperative mode
+	"D417", # Argument description required
+	"E501", # Line too long (exceeds the maximum line length)
+	"S101", # Use of assert detected
+	"S102", # Use of exec detected
+	"S104", # Possible binding to all interfaces
+	"S324", # Use of insecure hash function
+	"EXE002", # File executable but no shebang found
+	"D100", # Missing docstring in public module
+	"D102", # Missing docstring in public method
+	"D203", # 1 blank line required before class docstring
+	"D206", # Docstring should be indented with spaces, not tabs
+	"D103", # Missing docstring in public function
+	"D104", # Missing docstring in public package
+	"D105", # Missing docstring in magic method
+	"D106", # Missing docstring in public nested class
+	"D101", # Missing docstring in public class
+	"D107", # Missing docstring in __init__
+	"D212", # Multi-line docstring summary should start at the first line
+	"D211", # No blank lines allowed before class docstring
+	"PGH003", # Use specific rule codes when ignoring type issues
+	"PGH004", # Use specific rule codes when using noqa
+	"N811", # Constant variable imported as non-constant
+	"N804", # The first argument of class method should be named 'cls'
+	"N818", # Error suffix should be used for exception names
+	"N806", # Variable in function should be lowercase
+	"N815", # Variable in function should be lowercase
+	"ARG001", # Unused function argument
+	"ARG002", # Unused method argument
+	"DTZ003", # Use of datetime.now() without timezone
+	"DTZ005", # Use of datetime.utcnow() without timezone
+	"RSE102", # Use of 'sys.exit()' or 'exit()' detected
+	"SLF001", # Private member accessed outside of class
+	"PLR", # Refactoring related issues https://docs.astral.sh/ruff/rules/#refactor-r
+	"INP", # Implicit namespace package
+	"TRY", # Tryceptor related issues https://docs.astral.sh/ruff/rules/#tryceratops-try
+	"SIM300", # Use of 'len(SEQUENCE) == 0' detected
+	"SIM114", # Use of 'if x is not None' detected
+	"DJ008", # Model does not define __str__ method
+	"FIX002", # Line contains
+	"S603", # Use of 'subprocess.call' detected
+	"S607", # Use of 'subprocess.run' detected
+	"TD002", # Missing
+	"TD003", # Missing
+	"W191", # Indentation contains tabs
+	"COM812", # Missing trailing comma
+	"ISC001", # Handled by formatter (Implicit string concatenation)
+	"BLE001", # Bare Exception / Blind Exception
+	"ERA001", # For ignoring False positive commented code like
+	"S105", # For hardcoded passwords / secrets
+	"SLOT000", # For using __slots__ without str inherited classes
+	"PLW2901", # For overriding for loop variable
+	"S113", # Ruff call without TimeOut
+	"N812", # Lowercase imported as non-lowercase
+	"B008", # Don't allow function calls in argument default
+]
+select = ["ALL"]
+
+[lint.flake8-annotations]
+suppress-none-returning = true
+
+[lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "double"
+multiline-quotes = "double"