chore: docs

Author: Harshal6927

pyproject.toml

@@ -44,8 +44,6 @@ line-length = 120
 lint.ignore = [
     "CPY001",  # Missing copyright notice
     "D100",    # Undocumented public module
-    "D203",    # One blank line required before class docstring (conflicts with D211)
-    "D213",    # Multi-line docstring summary should start at the second line (conflicts with D212)
     "PLC0415", # Import outside top level
     "PLR0911", # Too many return statements
 ]

src/Litestar/generator.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 
 from jinja2 import Environment
+
 from src.models import DatabaseConfig, ProjectConfig
 from src.utils import get_package_dir, get_template_env, write_file
 
@@ -23,7 +24,12 @@ def __init__(self, config: ProjectConfig, output_dir: Path) -> None:
         self.litestar_dir = get_package_dir() / "Litestar"
 
     def _get_template_context(self) -> dict:
-        """Build the template context."""
+        """Build the template context.
+
+        Returns:
+            The template context dictionary.
+
+        """
         db_config = DatabaseConfig.for_database(self.config.database)
 
         return {

src/cli.py

@@ -23,7 +23,12 @@ def print_banner() -> None:
 
 
 def ask_project_name() -> str:
-    """Ask for the project name."""
+    """Ask for the project name.
+
+    Returns:
+        The validated project name.
+
+    """
     while True:
         name = questionary.text(
             "What is your project name?",
@@ -43,7 +48,12 @@ def ask_project_name() -> str:
 
 
 def ask_framework() -> Framework:
-    """Ask for the backend framework."""
+    """Ask for the backend framework.
+
+    Returns:
+        The selected framework.
+
+    """
     choices = [
         questionary.Choice(title="Litestar", value=Framework.LITESTAR),
     ]
@@ -61,7 +71,12 @@ def ask_framework() -> Framework:
 
 
 def ask_database() -> Database:
-    """Ask for the database choice."""
+    """Ask for the database choice.
+
+    Returns:
+        The selected database.
+
+    """
     choices = [
         questionary.Choice(title="PostgreSQL", value=Database.POSTGRESQL),
         questionary.Choice(title="SQLite", value=Database.SQLITE),
@@ -82,7 +97,15 @@ def ask_database() -> Database:
 
 
 def ask_plugins(database: Database) -> list[Plugin]:
-    """Ask for plugins to install."""
+    """Ask for plugins to install.
+
+    Args:
+        database: The selected database to determine plugin availability.
+
+    Returns:
+        A list of selected plugins.
+
+    """
     choices = []
 
     # SQLAlchemy only makes sense with a database
@@ -111,7 +134,12 @@ def ask_plugins(database: Database) -> list[Plugin]:
 
 
 def ask_docker() -> tuple[bool, bool]:
-    """Ask for Docker configuration."""
+    """Ask for Docker configuration.
+
+    Returns:
+        A tuple of (generate_dockerfile, generate_docker_infra).
+
+    """
     docker = questionary.confirm(
         "Generate Dockerfile for the application?",
         default=False,

src/docs/ARCHITECTURE.md

@@ -120,7 +120,7 @@ All templates use **Jinja2** with `.jinja` extension. Template context includes:
 
 2. Add to `Plugin` enum in `models.py`:
    ```python
-   class Plugin(str, Enum):
+   class Plugin(StrEnum):
        SQLALCHEMY = "SQLAlchemy"
        JWT = "JWT"
        NEW_PLUGIN = "NewPlugin"  # Add this

src/models.py

@@ -1,17 +1,17 @@
 """Data models for project configuration."""
 
-from enum import Enum
+from enum import StrEnum
 
 import msgspec
 
 
-class Framework(str, Enum):
+class Framework(StrEnum):
     """Supported backend frameworks."""
 
     LITESTAR = "Litestar"
 
 
-class Database(str, Enum):
+class Database(StrEnum):
     """Supported database options."""
 
     POSTGRESQL = "PostgreSQL"
@@ -20,7 +20,7 @@ class Database(str, Enum):
     NONE = "None"
 
 
-class Plugin(str, Enum):
+class Plugin(StrEnum):
     """Available plugins."""
 
     SQLALCHEMY = "SQLAlchemy"
@@ -68,7 +68,15 @@ class DatabaseConfig(msgspec.Struct):
 
     @classmethod
     def for_database(cls, db: Database) -> "DatabaseConfig | None":
-        """Get configuration for a specific database."""
+        """Get configuration for a specific database.
+
+        Args:
+            db: The database type.
+
+        Returns:
+            The configuration for the specified database, or None if not found.
+
+        """
         configs = {
             Database.POSTGRESQL: cls(
                 driver="postgresql+asyncpg",

src/utils.py

@@ -10,12 +10,25 @@
 
 
 def get_package_dir() -> Path:
-    """Get the package directory."""
+    """Get the package directory.
+
+    Returns:
+        The path to the package directory.
+
+    """
     return Path(__file__).parent
 
 
 def get_template_env(template_dir: Path) -> Environment:
-    """Create a Jinja2 environment for the given template directory."""
+    """Create a Jinja2 environment for the given template directory.
+
+    Args:
+        template_dir: The directory containing the templates.
+
+    Returns:
+        A configured Jinja2 environment.
+
+    """
     return Environment(
         loader=FileSystemLoader(str(template_dir)),
         autoescape=select_autoescape(default=False),
@@ -26,7 +39,15 @@ def get_template_env(template_dir: Path) -> Environment:
 
 
 def slugify(text: str) -> str:
-    """Convert text to a valid Python package name."""
+    """Convert text to a valid Python package name.
+
+    Args:
+        text: The text to slugify.
+
+    Returns:
+        The slugified text.
+
+    """
     # Convert to lowercase
     text = text.lower()
     # Replace spaces and hyphens with underscores
@@ -40,7 +61,15 @@ def slugify(text: str) -> str:
 
 
 def validate_project_name(name: str) -> str | None:
-    """Validate project name. Returns error message or None if valid."""
+    """Validate project name. Returns error message or None if valid.
+
+    Args:
+        name: The project name to validate.
+
+    Returns:
+        An error message if the name is invalid, otherwise None.
+
+    """
     if not name:
         return "Project name cannot be empty"
     if len(name) < MIN_PROJECT_NAME_LENGTH:
@@ -66,6 +95,16 @@ def write_file(path: Path, content: str) -> None:
 
 
 def render_template(env: Environment, template_name: str, context: dict) -> str:
-    """Render a Jinja2 template with the given context."""
+    """Render a Jinja2 template with the given context.
+
+    Args:
+        env: The Jinja2 environment.
+        template_name: The name of the template to render.
+        context: The context dictionary to render the template with.
+
+    Returns:
+        The rendered template string.
+
+    """
     template = env.get_template(template_name)
     return template.render(**context)