drf-to-mkdoc 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

drf_to_mkdoc/__init__.py

@@ -1,7 +1,7 @@
-"""
-DRF to MkDocs - Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
-"""
-
-__version__ = "0.1.0"
-__author__ = "ShayestehHs"
+"""
+DRF to MkDocs - Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
+"""
+
+__version__ = "0.1.0"
+__author__ = "ShayestehHs"
 __email__ = "shayestehhs1@gmail.com"

drf_to_mkdoc/apps.py

@@ -1,15 +1,15 @@
-from django.apps import AppConfig
-
-
-class DrfToMkdocConfig(AppConfig):
-    default_auto_field = "django.db.models.BigAutoField"
-    name = "drf_to_mkdoc"
-    verbose_name = "DRF to MkDocs Documentation Generator"
-    
-    def ready(self):
-        """Initialize the app when Django starts."""
-        # Import management commands to register them
-        try:
-            import drf_to_mkdoc.management.commands  # noqa
-        except ImportError:
+from django.apps import AppConfig
+
+
+class DrfToMkdocConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "drf_to_mkdoc"
+    verbose_name = "DRF to MkDocs Documentation Generator"
+    
+    def ready(self):
+        """Initialize the app when Django starts."""
+        # Import management commands to register them
+        try:
+            import drf_to_mkdoc.management.commands  # noqa
+        except ImportError:
             pass 

drf_to_mkdoc/conf/settings.py

@@ -1,44 +1,44 @@
-from django.conf import settings
-from drf_to_mkdoc.conf.defaults import DEFAULTS
-
-class DRFToMkDocSettings:
-    required_settings = ["DJANGO_APPS"]
-
-    def __init__(self, user_settings_key="DRF_TO_MKDOC", defaults=None):
-        self.user_settings_key = user_settings_key
-        self._user_settings = getattr(settings, user_settings_key, {})
-        self.defaults = defaults or {}
-
-    def get(self, key):
-        if key not in self.defaults:
-            raise AttributeError(f"Invalid DRF_TO_MKDOC setting: '{key}'")
-        
-        value = self._user_settings.get(key, self.defaults[key])
-        
-        if value is None and key in self.required_settings:
-            raise ValueError(
-                f"DRF_TO_MKDOC setting '{key}' is required but not configured. "
-                f"Please add it to your Django settings under {self.user_settings_key}."
-            )
-        
-        return value
-
-    def __getattr__(self, key):
-        return self.get(key)
-
-    def validate_required_settings(self):
-        missing_settings = []
-        
-        for setting in self.required_settings:
-            try:
-                self.get(setting)
-            except ValueError:
-                missing_settings.append(setting)
-        
-        if missing_settings:
-            raise ValueError(
-                f"Missing required settings: {', '.join(missing_settings)}. "
-                f"Please configure these in your Django settings under {self.user_settings_key}."
-            )
-
-drf_to_mkdoc_settings = DRFToMkDocSettings(defaults=DEFAULTS)
+from django.conf import settings
+from drf_to_mkdoc.conf.defaults import DEFAULTS
+
+class DRFToMkDocSettings:
+    required_settings = ["DJANGO_APPS"]
+
+    def __init__(self, user_settings_key="DRF_TO_MKDOC", defaults=None):
+        self.user_settings_key = user_settings_key
+        self._user_settings = getattr(settings, user_settings_key, {})
+        self.defaults = defaults or {}
+
+    def get(self, key):
+        if key not in self.defaults:
+            raise AttributeError(f"Invalid DRF_TO_MKDOC setting: '{key}'")
+        
+        value = self._user_settings.get(key, self.defaults[key])
+        
+        if value is None and key in self.required_settings:
+            raise ValueError(
+                f"DRF_TO_MKDOC setting '{key}' is required but not configured. "
+                f"Please add it to your Django settings under {self.user_settings_key}."
+            )
+        
+        return value
+
+    def __getattr__(self, key):
+        return self.get(key)
+
+    def validate_required_settings(self):
+        missing_settings = []
+        
+        for setting in self.required_settings:
+            try:
+                self.get(setting)
+            except ValueError:
+                missing_settings.append(setting)
+        
+        if missing_settings:
+            raise ValueError(
+                f"Missing required settings: {', '.join(missing_settings)}. "
+                f"Please configure these in your Django settings under {self.user_settings_key}."
+            )
+
+drf_to_mkdoc_settings = DRFToMkDocSettings(defaults=DEFAULTS)

drf_to_mkdoc/management/commands/build_docs.py

@@ -1,76 +1,76 @@
-import subprocess
-from pathlib import Path
-
-from django.conf import settings
-from django.core.management.base import BaseCommand, CommandError
-from django.apps import apps
-from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
-from django.core.management import call_command
-
-
-class Command(BaseCommand):
-    help = "Build MkDocs documentation"
-
-    def handle(self, *args, **options):
-        drf_to_mkdoc_settings.validate_required_settings()
-        self.stdout.write(self.style.SUCCESS("✅ DRF_TO_MKDOC settings validated."))
-
-        try:
-            apps.check_apps_ready()
-        except Exception as e:
-            raise CommandError(f"Django apps not properly configured: {e}")
-
-        base_dir = Path(settings.BASE_DIR)
-        site_dir = base_dir / "site"
-        mkdocs_config = base_dir / "mkdocs.yml"
-        mkdocs_config_alt = base_dir / "mkdocs.yaml"
-        
-        if not mkdocs_config.exists() and not mkdocs_config_alt.exists():
-            raise CommandError(
-                "MkDocs configuration file not found. Please create either 'mkdocs.yml' or 'mkdocs.yaml' "
-                "in your project root directory."
-            )
-
-        try:
-            # Generate the model documentation JSON first
-            self.stdout.write("Generating model documentation...")
-
-            try:
-                call_command(
-                    "generate_model_docs", "--pretty"
-                )
-                self.stdout.write(self.style.SUCCESS("Model documentation generated."))
-            except Exception as e:
-                self.stdout.write(self.style.WARNING(f"Failed to generate model docs: {e}"))
-
-            # Generate the documentation content
-            self.stdout.write("Generating documentation content...")
-            try:
-                call_command("generate_docs")
-                self.stdout.write(self.style.SUCCESS("Documentation content generated."))
-            except Exception as e:
-                self.stdout.write(self.style.ERROR(f"Failed to generate docs: {e}"))
-                raise
-
-            # Build the MkDocs site
-            self.stdout.write("Building MkDocs site...")
-            result = subprocess.run(
-                ["mkdocs", "build", "--clean"],
-                check=False,
-                cwd=base_dir,
-                capture_output=True,
-                text=True,
-            )
-
-            if result.returncode != 0:
-                raise CommandError(f"MkDocs build failed: {result.stderr}")
-
-            self.stdout.write(self.style.SUCCESS("Documentation built successfully!"))
-            self.stdout.write(f"Site built in: {site_dir}")
-
-        except FileNotFoundError as e:
-            raise CommandError(
-                "MkDocs not found. Please install it with: pip install mkdocs mkdocs-material"
-            ) from e
-        except Exception as e:
-            raise CommandError(f"Error building documentation: {e!s}") from e
+import subprocess
+from pathlib import Path
+
+from django.conf import settings
+from django.core.management.base import BaseCommand, CommandError
+from django.apps import apps
+from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
+from django.core.management import call_command
+
+
+class Command(BaseCommand):
+    help = "Build MkDocs documentation"
+
+    def handle(self, *args, **options):
+        drf_to_mkdoc_settings.validate_required_settings()
+        self.stdout.write(self.style.SUCCESS("✅ DRF_TO_MKDOC settings validated."))
+
+        try:
+            apps.check_apps_ready()
+        except Exception as e:
+            raise CommandError(f"Django apps not properly configured: {e}")
+
+        base_dir = Path(settings.BASE_DIR)
+        site_dir = base_dir / "site"
+        mkdocs_config = base_dir / "mkdocs.yml"
+        mkdocs_config_alt = base_dir / "mkdocs.yaml"
+        
+        if not mkdocs_config.exists() and not mkdocs_config_alt.exists():
+            raise CommandError(
+                "MkDocs configuration file not found. Please create either 'mkdocs.yml' or 'mkdocs.yaml' "
+                "in your project root directory."
+            )
+
+        try:
+            # Generate the model documentation JSON first
+            self.stdout.write("Generating model documentation...")
+
+            try:
+                call_command(
+                    "generate_model_docs", "--pretty"
+                )
+                self.stdout.write(self.style.SUCCESS("Model documentation generated."))
+            except Exception as e:
+                self.stdout.write(self.style.WARNING(f"Failed to generate model docs: {e}"))
+
+            # Generate the documentation content
+            self.stdout.write("Generating documentation content...")
+            try:
+                call_command("generate_docs")
+                self.stdout.write(self.style.SUCCESS("Documentation content generated."))
+            except Exception as e:
+                self.stdout.write(self.style.ERROR(f"Failed to generate docs: {e}"))
+                raise
+
+            # Build the MkDocs site
+            self.stdout.write("Building MkDocs site...")
+            result = subprocess.run(
+                ["mkdocs", "build", "--clean"],
+                check=False,
+                cwd=base_dir,
+                capture_output=True,
+                text=True,
+            )
+
+            if result.returncode != 0:
+                raise CommandError(f"MkDocs build failed: {result.stderr}")
+
+            self.stdout.write(self.style.SUCCESS("Documentation built successfully!"))
+            self.stdout.write(f"Site built in: {site_dir}")
+
+        except FileNotFoundError as e:
+            raise CommandError(
+                "MkDocs not found. Please install it with: pip install mkdocs mkdocs-material"
+            ) from e
+        except Exception as e:
+            raise CommandError(f"Error building documentation: {e!s}") from e