drf-to-mkdoc 0.1.5__tar.gz → 0.1.6__tar.gz

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.5
+Version: 0.1.6
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/conf/defaults.py

@@ -7,4 +7,5 @@ DEFAULTS = {
     },
     "INDEX_TEMPLATE": "index.md",
     "AUTH_TEMPLATE": "auth.md",
+    "PATH_PARAM_SUBSTITUTOR": None,
 }

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/drf_to_mkdoc/management/commands/generate_model_docs.py

@@ -139,21 +139,50 @@ class Command(BaseCommand):
 
     def introspect_relationship(self, field):
         """Introspect relationship fields"""
-        return {
+        # Safely resolve related model label; can be None for generic relations
+        related_model_label = None
+        try:
+            if getattr(field, "related_model", None) is not None:
+                related_model_label = (
+                    f"{field.related_model._meta.app_label}.{field.related_model.__name__}"
+                )
+        except Exception:
+            related_model_label = None
+
+        relationship_data = {
             "name": field.name,
             "type": field.__class__.__name__,
-            "related_model": f"{field.related_model._meta.app_label}."
-            f"{field.related_model.__name__}",
+            "related_model": related_model_label,
             "related_name": getattr(field, "related_name", None),
             "on_delete": self.get_on_delete_name(field),
             "null": getattr(field, "null", False),
             "blank": getattr(field, "blank", False),
-            "many_to_many": field.many_to_many,
-            "one_to_many": field.one_to_many,
-            "many_to_one": field.many_to_one,
-            "one_to_one": field.one_to_one,
+            "many_to_many": getattr(field, "many_to_many", False),
+            "one_to_many": getattr(field, "one_to_many", False),
+            "many_to_one": getattr(field, "many_to_one", False),
+            "one_to_one": getattr(field, "one_to_one", False),
         }
 
+        # Handle Django generic relations where related_model can be None
+        field_class_name = field.__class__.__name__
+        if field_class_name in ("GenericForeignKey", "GenericRelation"):
+            relationship_data["is_generic"] = True
+            # Capture common generic relation details when available
+            for attr_name in (
+                "ct_field",
+                "fk_field",
+                "object_id_field",
+                "content_type_field",
+                "for_concrete_model",
+                "related_query_name",
+            ):
+                if hasattr(field, attr_name):
+                    relationship_data[attr_name] = getattr(field, attr_name)
+        else:
+            relationship_data["is_generic"] = False
+
+        return relationship_data
+
     def get_on_delete_name(self, field):
         """Get readable name for on_delete option"""
         if not hasattr(field, "on_delete") or field.on_delete is None:

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/drf_to_mkdoc/utils/common.py

@@ -170,16 +170,16 @@ def get_custom_schema():
 def convert_to_django_path(path: str, parameters: list[dict[str, Any]]) -> str:
     """
     Convert a path with {param} to a Django-style path with <type:param>.
-    If DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is set, use that function instead.
+    If PATH_PARAM_SUBSTITUTOR is set, use that function instead.
     """
     function = None
-    func_path = getattr(drf_to_mkdoc_settings, "DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR", None)
+    func_path = getattr(drf_to_mkdoc_settings, "PATH_PARAM_SUBSTITUTOR", None)
 
     if func_path:
         try:
             function = import_string(func_path)
         except ImportError:
-            logger.warning("DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is not a valid import path")
+            logger.warning("PATH_PARAM_SUBSTITUTOR is not a valid import path")
 
     # If custom function exists and returns a valid value, use it
     if callable(function):
@@ -292,7 +292,7 @@ def extract_viewset_from_operation_id(operation_id: str):
             return view_func
 
     except Exception as e:
-        raise RuntimeError(f"Failed to resolve path {django_path}: {e}") from e
+        logger.error(f"Failed to resolve path {path}")
 
 
 def extract_viewset_name_from_operation_id(operation_id: str):

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/drf_to_mkdoc/utils/extractors/query_parameter_extractors.py

@@ -186,6 +186,10 @@ def _extract_filterset_fields_from_internal_attrs(filterset_class: Any) -> list[
 
 
 def _extract_filterset_fields_from_get_fields(filterset_class: Any) -> list[str]:
+    if not hasattr(filterset_class, "_meta"):
+        # If the Meta class is not defined in the Filter class,
+        # the get_fields function is raise error
+        return []
     fields = []
 
     # Try get_fields() method if available (for dynamic filters)

{drf_to_mkdoc-0.1.5 → drf_to_mkdoc-0.1.6}/drf_to_mkdoc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.5
+Version: 0.1.6
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>

drf_to_mkdoc-0.1.6/drf_to_mkdoc.egg-info/SOURCES.txt

@@ -0,0 +1,54 @@
+CONTRIBUTING.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+.github/workflows/publish.yaml
+conf/__init__.py
+conf/defaults.py
+conf/settings.py
+docs/customizing_endpoints.md
+docs/serving_mkdocs_with_django.md
+drf_to_mkdoc/__init__.py
+drf_to_mkdoc/apps.py
+drf_to_mkdoc.egg-info/PKG-INFO
+drf_to_mkdoc.egg-info/SOURCES.txt
+drf_to_mkdoc.egg-info/dependency_links.txt
+drf_to_mkdoc.egg-info/requires.txt
+drf_to_mkdoc.egg-info/top_level.txt
+drf_to_mkdoc/conf/__init__.py
+drf_to_mkdoc/conf/defaults.py
+drf_to_mkdoc/conf/settings.py
+drf_to_mkdoc/management/__init__.py
+drf_to_mkdoc/management/commands/__init__.py
+drf_to_mkdoc/management/commands/build_docs.py
+drf_to_mkdoc/management/commands/generate_doc_json.py
+drf_to_mkdoc/management/commands/generate_docs.py
+drf_to_mkdoc/management/commands/generate_model_docs.py
+drf_to_mkdoc/management/commands/update_doc_schema.py
+drf_to_mkdoc/static/drf-to-mkdoc/javascripts/endpoints-filter.js
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/extra.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/accessibility.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/animations.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/badges.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/base.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/endpoint-content.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/endpoints-grid.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/filter-section.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/fixes.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/layout.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/loading.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/responsive.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/sections.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/stats.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/tags.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/theme-toggle.css
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/variables.css
+drf_to_mkdoc/utils/__init__.py
+drf_to_mkdoc/utils/common.py
+drf_to_mkdoc/utils/endpoint_generator.py
+drf_to_mkdoc/utils/model_generator.py
+drf_to_mkdoc/utils/extractors/__init__.py
+drf_to_mkdoc/utils/extractors/query_parameter_extractors.py
+drf_to_mkdoc/utils/md_generators/__init__.py
+drf_to_mkdoc/utils/md_generators/query_parameters_generators.py

drf_to_mkdoc-0.1.5/drf_to_mkdoc.egg-info/SOURCES.txt

@@ -1,54 +0,0 @@
-CONTRIBUTING.md
-LICENSE
-MANIFEST.in
-README.md
-pyproject.toml
-.github/workflows/publish.yaml
-conf/__init__.py
-conf/defaults.py
-conf/settings.py
-docs/customizing_endpoints.md
-docs/serving_mkdocs_with_django.md
-drf_to_mkdoc/__init__.py
-drf_to_mkdoc/apps.py
-drf_to_mkdoc.egg-info/PKG-INFO
-drf_to_mkdoc.egg-info/SOURCES.txt
-drf_to_mkdoc.egg-info/dependency_links.txt
-drf_to_mkdoc.egg-info/requires.txt
-drf_to_mkdoc.egg-info/top_level.txt
-drf_to_mkdoc/conf/__init__.py
-drf_to_mkdoc/conf/defaults.py
-drf_to_mkdoc/conf/settings.py
-drf_to_mkdoc/management/__init__.py
-drf_to_mkdoc/management/commands/__init__.py
-drf_to_mkdoc/management/commands/build_docs.py
-drf_to_mkdoc/management/commands/generate_doc_json.py
-drf_to_mkdoc/management/commands/generate_docs.py
-drf_to_mkdoc/management/commands/generate_model_docs.py
-drf_to_mkdoc/management/commands/update_doc_schema.py
-drf_to_mkdoc/utils/__init__.py
-drf_to_mkdoc/utils/common.py
-drf_to_mkdoc/utils/endpoint_generator.py
-drf_to_mkdoc/utils/model_generator.py
-drf_to_mkdoc/utils/extractors/__init__.py
-drf_to_mkdoc/utils/extractors/query_parameter_extractors.py
-drf_to_mkdoc/utils/md_generators/__init__.py
-drf_to_mkdoc/utils/md_generators/query_parameters_generators.py
-static/javascripts/endpoints-filter.js
-static/stylesheets/extra.css
-static/stylesheets/endpoints/accessibility.css
-static/stylesheets/endpoints/animations.css
-static/stylesheets/endpoints/badges.css
-static/stylesheets/endpoints/base.css
-static/stylesheets/endpoints/endpoint-content.css
-static/stylesheets/endpoints/endpoints-grid.css
-static/stylesheets/endpoints/filter-section.css
-static/stylesheets/endpoints/fixes.css
-static/stylesheets/endpoints/layout.css
-static/stylesheets/endpoints/loading.css
-static/stylesheets/endpoints/responsive.css
-static/stylesheets/endpoints/sections.css
-static/stylesheets/endpoints/stats.css
-static/stylesheets/endpoints/tags.css
-static/stylesheets/endpoints/theme-toggle.css
-static/stylesheets/endpoints/variables.css