drf-to-mkdoc 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

drf_to_mkdoc/__init__.py

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

drf_to_mkdoc/apps.py

@@ -1,15 +1,19 @@
+import logging
+
 from django.apps import AppConfig
 
+logger = logging.getLogger()
+
 
 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 
+            logger.exception("Failed to import drf_to_mkdoc commands")

drf_to_mkdoc/conf/defaults.py

@@ -5,7 +5,6 @@ DEFAULTS = {
     "MODEL_DOCS_FILE": "docs/model-docs.json",  # Path to model documentation JSON file
     "DOC_CONFIG_FILE": "docs/configs/doc_config.json",  # Path to documentation configuration file
     "CUSTOM_SCHEMA_FILE": "docs/configs/custom_schema.json",  # Path to custom schema file
-
     # Django apps - required, no default
     "DJANGO_APPS": None,  # List of Django app names to process
 }

drf_to_mkdoc/conf/settings.py

@@ -1,8 +1,11 @@
 from django.conf import settings
+
 from drf_to_mkdoc.conf.defaults import DEFAULTS
 
+
 class DRFToMkDocSettings:
     required_settings = ["DJANGO_APPS"]
+    project_settings = {"PROJECT_NAME": "drf-to-mkdoc"}
 
     def __init__(self, user_settings_key="DRF_TO_MKDOC", defaults=None):
         self.user_settings_key = user_settings_key
@@ -11,16 +14,18 @@ class DRFToMkDocSettings:
 
     def get(self, key):
         if key not in self.defaults:
+            if key in self.project_settings:
+                return self.project_settings[key]
             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):
@@ -28,17 +33,18 @@ class DRFToMkDocSettings:
 
     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,11 +1,13 @@
+import shutil
 import subprocess
 from pathlib import Path
 
+from django.apps import apps
 from django.conf import settings
+from django.core.management import call_command
 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):
@@ -18,13 +20,13 @@ class Command(BaseCommand):
         try:
             apps.check_apps_ready()
         except Exception as e:
-            raise CommandError(f"Django apps not properly configured: {e}")
+            raise CommandError(f"Django apps not properly configured: {e}") from 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' "
@@ -34,10 +36,7 @@ class Command(BaseCommand):
         try:
             # Generate the model documentation JSON first
             self.stdout.write("Generating model documentation...")
-
-            call_command(
-                "generate_model_docs", "--pretty"
-            )
+            call_command("generate_model_docs", "--pretty")
             self.stdout.write(self.style.SUCCESS("Model documentation generated."))
 
             # Generate the documentation content
@@ -47,17 +46,7 @@ class Command(BaseCommand):
 
             # 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._build_mkdocs_site(base_dir, site_dir)
             self.stdout.write(self.style.SUCCESS("Documentation built successfully!"))
             self.stdout.write(f"Site built in: {site_dir}")
 
@@ -65,3 +54,56 @@ class Command(BaseCommand):
             raise CommandError(
                 "MkDocs not found. Please install it with: pip install mkdocs mkdocs-material"
             ) from e
+
+    def _build_mkdocs_site(self, base_dir: Path, site_dir: Path) -> None:
+        """
+        Build the MkDocs site with proper security checks.
+
+        Args:
+            base_dir: The base directory of the Django project
+            site_dir: The directory where the site will be built
+
+        Raises:
+            FileNotFoundError: If mkdocs executable is not found
+            CommandError: If the build process fails
+        """
+        mkdocs_path = shutil.which("mkdocs")
+        if not mkdocs_path:
+            raise FileNotFoundError("mkdocs executable not found in PATH")
+
+        mkdocs_path_obj = Path(mkdocs_path)
+        if not mkdocs_path_obj.exists() or not mkdocs_path_obj.is_file():
+            raise CommandError(f"Invalid mkdocs executable path: {mkdocs_path}")
+
+        if not base_dir.is_absolute():
+            base_dir = base_dir.resolve()
+
+        if not base_dir.exists():
+            raise CommandError(f"Base directory does not exist: {base_dir}")
+
+        cmd = [
+            str(mkdocs_path_obj),  # Convert to string for subprocess
+            "build",
+            "--clean",
+        ]
+
+        try:
+            result = subprocess.run(  # noqa S603
+                cmd,
+                check=True,
+                cwd=str(base_dir),
+                capture_output=True,
+                text=True,
+                timeout=300,
+            )
+
+            if result.stdout:
+                self.stdout.write(f"MkDocs output: {result.stdout}")
+
+        except subprocess.TimeoutExpired as e:
+            raise CommandError("MkDocs build timed out after 5 minutes") from e
+        except subprocess.CalledProcessError as e:
+            error_msg = f"MkDocs build failed (exit code {e.returncode})"
+            if e.stderr:
+                error_msg += f": {e.stderr}"
+            raise CommandError(error_msg) from e

drf_to_mkdoc/management/commands/generate_docs.py

@@ -4,15 +4,15 @@ from pathlib import Path
 
 from django.core.management.base import BaseCommand
 
+from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
 from drf_to_mkdoc.utils.common import get_schema, load_model_json_data
-from drf_to_mkdoc.utils.endpoint_generator import (
-    create_endpoints_index,
+from drf_to_mkdoc.utils.endpoint_detail_generator import (
     generate_endpoint_files,
     parse_endpoints_from_schema,
 )
-from drf_to_mkdoc.utils.model_generator import create_models_index, generate_model_docs
-from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
-
+from drf_to_mkdoc.utils.endpoint_list_generator import create_endpoints_index
+from drf_to_mkdoc.utils.model_detail_generator import generate_model_docs
+from drf_to_mkdoc.utils.model_list_generator import create_models_index
 
 
 class Command(BaseCommand):

drf_to_mkdoc/management/commands/generate_model_docs.py

@@ -9,6 +9,7 @@ from django.db import models
 
 from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
 
+
 class Command(BaseCommand):
     help = "Generate model documentation JSON from Django model introspection"
 

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/base.css

@@ -13,3 +13,72 @@ body {
     padding: 0;
     min-height: 100vh;
 }
+
+.md-nav__item--active > .md-nav__link {
+    font-weight: 600;
+}
+
+/* Admonition customizations */
+.admonition.note {
+    border-left-color: var(--md-primary-fg-color);
+}
+
+.admonition.tip {
+    border-left-color: #00c853;
+}
+
+.admonition.warning {
+    border-left-color: #ff9800;
+}
+
+.admonition.danger {
+    border-left-color: #f44336;
+}
+
+/* Search result enhancements */
+.md-search-result__meta {
+    color: var(--md-default-fg-color--light);
+}
+
+/* Code syntax highlighting enhancements */
+.codehilite .k { color: #0066cc; }  /* Keywords */
+.codehilite .s { color: #009900; }  /* Strings */
+.codehilite .c { color: #999999; }  /* Comments */
+.codehilite .n { color: #333333; }  /* Names */
+.codehilite .o { color: #666666; }  /* Operators */
+
+/* Custom icons for different sections */
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="models"] {
+    position: relative;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="models"]::before {
+    content: "🗃️";
+    margin-right: 0.5rem;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="endpoints"] {
+    position: relative;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="endpoints"]::before {
+    content: "🔗";
+    margin-right: 0.5rem;
+}
+
+/* Print styles */
+@media print {
+    .md-header, .md-sidebar, .md-footer {
+        display: none;
+    }
+
+    .md-content {
+        margin: 0;
+    }
+
+    .highlight pre {
+        border: 1px solid #ccc;
+        page-break-inside: avoid;
+    }
+}
+

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/endpoint-content.css

@@ -46,3 +46,120 @@
     font-family: monospace;
     border: 1px solid var(--border-color);
 }
+
+/* Enhanced code blocks  */
+.highlight pre {
+    border-left: 4px solid var(--md-primary-fg-color);
+    background-color: var(--md-code-bg-color);
+    padding: 1rem;
+    border-radius: 0.2rem;
+}
+
+/* Model field tables  */
+table {
+    border-collapse: collapse;
+    width: 100%;
+    margin: 1rem 0;
+}
+
+table th {
+    background-color: var(--md-primary-fg-color--light);
+    color: var(--md-primary-bg-color);
+    padding: 0.75rem;
+    text-align: left;
+    font-weight: 600;
+}
+
+table td {
+    padding: 0.75rem;
+    border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+table tr:hover {
+    background-color: var(--md-accent-fg-color--transparent);
+}
+
+/* Field and method grids  */
+.field-grid, .method-grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 1rem;
+    margin: 1rem 0;
+}
+
+.field-item, .method-item {
+    background-color: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 0.2rem;
+    padding: 1rem;
+}
+
+.field-item h4, .method-item h4 {
+    margin-top: 0;
+    color: var(--md-primary-fg-color);
+}
+
+/* API endpoint sections  */
+.endpoint-section {
+    border-left: 4px solid var(--md-accent-fg-color);
+    padding-left: 1rem;
+    margin: 2rem 0;
+}
+
+.endpoint-header {
+    display: flex;
+    align-items: center;
+    margin-bottom: 1rem;
+}
+
+/* Enhanced code blocks */
+.highlight pre {
+    border-left: 4px solid var(--md-primary-fg-color);
+    background-color: var(--md-code-bg-color);
+    padding: 1rem;
+    border-radius: 0.2rem;
+}
+
+/* Model field tables */
+table {
+    border-collapse: collapse;
+    width: 100%;
+    margin: 1rem 0;
+}
+
+table th {
+    background-color: var(--md-primary-fg-color--light);
+    color: var(--md-primary-bg-color);
+    padding: 0.75rem;
+    text-align: left;
+    font-weight: 600;
+}
+
+table td {
+    padding: 0.75rem;
+    border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+table tr:hover {
+    background-color: var(--md-accent-fg-color--transparent);
+}
+
+/* Field and method grids */
+.field-grid, .method-grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 1rem;
+    margin: 1rem 0;
+}
+
+.field-item, .method-item {
+    background-color: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 0.2rem;
+    padding: 1rem;
+}
+
+.field-item h4, .method-item h4 {
+    margin-top: 0;
+    color: var(--md-primary-fg-color);
+}

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/endpoints-grid.css

@@ -73,3 +73,122 @@
     position: relative;
     z-index: 2;
 }
+
+/* ===== DJANGO MODELS CARD LAYOUT ===== */
+/* Models container */
+.models-container {
+    max-width: 100%;
+    margin: 0 auto;
+}
+
+/* App description styling */
+.app-description {
+    font-size: 1rem;
+    color: var(--md-default-fg-color--light);
+    margin-bottom: 1.5rem;
+    padding: 0.5rem 0;
+    border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+/* Model cards grid */
+.model-cards {
+    display: grid;
+    grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
+    gap: 1.5rem;
+    margin-bottom: 3rem;
+}
+
+/* Individual model card */
+.model-card {
+    background: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 8px;
+    padding: 1.5rem;
+    transition: all 0.3s ease;
+    box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+    position: relative;
+    overflow: hidden;
+}
+
+.model-card:hover {
+    transform: translateY(-4px);
+    box-shadow: 0 8px 16px rgba(0, 0, 0, 0.15);
+    border-color: var(--md-primary-fg-color);
+}
+
+.model-card::before {
+    content: '';
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    height: 4px;
+    background: linear-gradient(90deg, var(--md-primary-fg-color), var(--md-accent-fg-color));
+    opacity: 0;
+    transition: opacity 0.3s ease;
+}
+
+.model-card:hover::before {
+    opacity: 1;
+}
+
+/* Model header */
+.model-header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    margin-bottom: 0.5rem;
+}
+
+.model-header h3 {
+    margin: 0;
+    font-size: 1.25rem;
+    font-weight: 600;
+}
+
+.model-header h3 a {
+    color: var(--md-default-fg-color);
+    text-decoration: none;
+    transition: color 0.3s ease;
+}
+
+.model-header h3 a:hover {
+    color: var(--md-primary-fg-color);
+}
+
+/* Model badge */
+.model-badge {
+    display: inline-block;
+    padding: 0.25rem 0.75rem;
+    background: var(--md-primary-fg-color);
+    color: var(--md-primary-bg-color);
+    border-radius: 20px;
+    font-size: 0.75rem;
+    font-weight: 600;
+    text-transform: uppercase;
+    letter-spacing: 0.5px;
+}
+
+/* Animation for cards appearing */
+@keyframes fadeInUp {
+    from {
+        opacity: 0;
+        transform: translateY(20px);
+    }
+    to {
+        opacity: 1;
+        transform: translateY(0);
+    }
+}
+
+.model-card {
+    animation: fadeInUp 0.6s ease-out;
+}
+
+/* Stagger animation for multiple cards */
+.model-card:nth-child(1) { animation-delay: 0.1s; }
+.model-card:nth-child(2) { animation-delay: 0.2s; }
+.model-card:nth-child(3) { animation-delay: 0.3s; }
+.model-card:nth-child(4) { animation-delay: 0.4s; }
+.model-card:nth-child(5) { animation-delay: 0.5s; }
+.model-card:nth-child(6) { animation-delay: 0.6s; }