standardize packaging, tooling, docs, CI, and licensing

docforge/loaders/griffe_loader.py

@@ -10,17 +10,18 @@ into doc-forge documentation models.
 
 import logging
 from pathlib import Path
-from typing import List, Optional
 
 from griffe import (
-    GriffeLoader as _GriffeLoader,
-    ModulesCollection,
-    LinesCollection,
-    Object,
     AliasResolutionError,
+    LinesCollection,
+    ModulesCollection,
+    Object,
+)
+from griffe import (
+    GriffeLoader as _GriffeLoader,
 )
 
-from docforge.models import Module, Project, DocObject
+from docforge.models import DocObject, Module, Project
 
 logger = logging.getLogger(__name__)
 
@@ -28,7 +29,7 @@ logger = logging.getLogger(__name__)
 def discover_module_paths(
     module_name: str,
     project_root: Path | None = None,
-) -> List[str]:
+) -> list[str]:
     """
     Discover Python modules within a package directory.
 
@@ -65,7 +66,7 @@ def discover_module_paths(
     if not pkg_dir.exists():
         raise FileNotFoundError(f"Package not found: {pkg_dir}")
 
-    module_paths: List[str] = []
+    module_paths: list[str] = []
 
     for path in pkg_dir.rglob("*.py"):
         if path.name == "__init__.py":
@@ -102,10 +103,10 @@ class GriffeLoader:
         )
 
     def load_project(
-            self,
-            module_paths: List[str],
-            project_name: Optional[str] = None,
-            skip_import_errors: bool = None,
+        self,
+        module_paths: list[str],
+        project_name: str | None = None,
+        skip_import_errors: bool = None,
     ) -> Project:
         """
         Load multiple modules and assemble them into a Project model.
@@ -250,7 +251,7 @@ class GriffeLoader:
     # Safe extractors
     # -------------------------
 
-    def _safe_docstring(self, obj: Object) -> Optional[str]:
+    def _safe_docstring(self, obj: Object) -> str | None:
         """
         Safely extract a docstring from a Griffe object.
 
@@ -267,7 +268,7 @@ class GriffeLoader:
         except AliasResolutionError:
             return None
 
-    def _safe_signature(self, obj: Object) -> Optional[str]:
+    def _safe_signature(self, obj: Object) -> str | None:
         """
         Safely extract the signature of a Griffe object.
 

docforge/loaders/griffe_loader.pyi

@@ -1,15 +1,11 @@
-from typing import List, Optional
 from pathlib import Path
 
 from docforge.models import Module, Project
 
-
 def discover_module_paths(
     module_name: str,
     project_root: Path | None = None,
-) -> List[str]:
-    ...
-
+) -> list[str]: ...
 
 class GriffeLoader:
     """Griffe-based introspection loaders.
@@ -18,11 +14,10 @@ class GriffeLoader:
     """
 
     def __init__(self) -> None: ...
-
     def load_project(
         self,
-        module_paths: List[str],
-        project_name: Optional[str] = ...,
+        module_paths: list[str],
+        project_name: str | None = ...,
         skip_import_errors: bool = ...,
     ) -> Project:
         """Load a documentation project from Python modules."""