standardize packaging, tooling, docs, CI, and licensing

docforge/models/__init__.pyi

@@ -1,6 +1,6 @@
-from .project import Project
 from .module import Module
 from .object import DocObject
+from .project import Project
 
 __all__ = [
     "Project",

docforge/models/module.py

@@ -9,7 +9,7 @@ model. A `Module` acts as a container for top-level documented objects
 introspection.
 """
 
-from typing import Dict, Iterable, Optional
+from collections.abc import Iterable
 
 from docforge.models.object import DocObject
 
@@ -36,7 +36,7 @@ class Module:
     def __init__(
         self,
         path: str,
-        docstring: Optional[str] = None,
+        docstring: str | None = None,
     ) -> None:
         """
         Initialize a Module instance.
@@ -50,7 +50,7 @@ class Module:
         """
         self.path = path
         self.docstring = docstring
-        self.members: Dict[str, DocObject] = {}
+        self.members: dict[str, DocObject] = {}
 
     def add_object(self, obj: DocObject) -> None:
         """

docforge/models/module.pyi

@@ -1,23 +1,19 @@
-from typing import Dict, Iterable, Optional
+from collections.abc import Iterable
 
 from docforge.models.object import DocObject
 
-
 class Module:
     """Represents a documented Python module."""
 
     path: str
-    docstring: Optional[str]
-    members: Dict[str, DocObject]
+    docstring: str | None
+    members: dict[str, DocObject]
 
     def __init__(
         self,
         path: str,
-        docstring: Optional[str] = ...,
+        docstring: str | None = ...,
     ) -> None: ...
-
     def add_object(self, obj: DocObject) -> None: ...
-
     def get_object(self, name: str) -> DocObject: ...
-
     def get_all_objects(self) -> Iterable[DocObject]: ...

docforge/models/object.py

@@ -9,7 +9,7 @@ entity such as a class, function, method, or attribute, and may contain nested
 members that form a hierarchical documentation structure.
 """
 
-from typing import Dict, Iterable, Optional
+from collections.abc import Iterable
 
 
 class DocObject:
@@ -45,8 +45,8 @@ class DocObject:
         name: str,
         kind: str,
         path: str,
-        signature: Optional[str] = None,
-        docstring: Optional[str] = None,
+        signature: str | None = None,
+        docstring: str | None = None,
     ) -> None:
         """
         Initialize a DocObject instance.
@@ -72,7 +72,7 @@ class DocObject:
         self.path = path
         self.signature = signature
         self.docstring = docstring
-        self.members: Dict[str, "DocObject"] = {}
+        self.members: dict[str, DocObject] = {}
 
     def add_member(self, obj: "DocObject") -> None:
         """

docforge/models/object.pyi

@@ -1,5 +1,4 @@
-from typing import Dict, Iterable, Optional
-
+from collections.abc import Iterable
 
 class DocObject:
     """Represents a documented Python object."""
@@ -7,21 +6,18 @@ class DocObject:
     name: str
     kind: str
     path: str
-    signature: Optional[str]
-    docstring: Optional[str]
-    members: Dict[str, "DocObject"]
+    signature: str | None
+    docstring: str | None
+    members: dict[str, DocObject]
 
     def __init__(
         self,
         name: str,
         kind: str,
         path: str,
-        signature: Optional[str] = ...,
-        docstring: Optional[str] = ...,
+        signature: str | None = ...,
+        docstring: str | None = ...,
     ) -> None: ...
-
-    def add_member(self, obj: "DocObject") -> None: ...
-
-    def get_member(self, name: str) -> "DocObject": ...
-
-    def get_all_members(self) -> Iterable["DocObject"]: ...
+    def add_member(self, obj: DocObject) -> None: ...
+    def get_member(self, name: str) -> DocObject: ...
+    def get_all_members(self) -> Iterable[DocObject]: ...

docforge/models/project.py

@@ -8,7 +8,7 @@ doc-forge to represent a documented codebase. A `Project` aggregates multiple
 modules and provides access to them through a unified interface.
 """
 
-from typing import Dict, Iterable
+from collections.abc import Iterable
 
 from docforge.models.module import Module
 
@@ -37,7 +37,7 @@ class Project:
                 Name used to identify the documentation project.
         """
         self.name = name
-        self.modules: Dict[str, Module] = {}
+        self.modules: dict[str, Module] = {}
 
     def add_module(self, module: Module) -> None:
         """
@@ -85,4 +85,4 @@ class Project:
             list[str]:
                 A list containing the dotted paths of all modules in the project.
         """
-        return list(self.modules.keys())
+        return list(self.modules.keys())

docforge/models/project.pyi

@@ -1,20 +1,15 @@
-from typing import Dict, Iterable
+from collections.abc import Iterable
 
 from docforge.models.module import Module
 
-
 class Project:
     """Represents a documentation project."""
 
     name: str
-    modules: Dict[str, Module]
+    modules: dict[str, Module]
 
     def __init__(self, name: str) -> None: ...
-
     def add_module(self, module: Module) -> None: ...
-
     def get_module(self, path: str) -> Module: ...
-
     def get_all_modules(self) -> Iterable[Module]: ...
-
     def get_module_list(self) -> list[str]: ...