drf-to-mkdoc 0.1.5__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"
 
@@ -139,21 +140,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/static/drf-to-mkdoc/javascripts/endpoints-filter.js

@@ -0,0 +1,189 @@
+let currentFilters = {
+    method: '',
+    path: '',
+    models: '',
+    auth: '',
+    roles: '',
+    contentType: '',
+    params: '',
+    schema: '',
+    pagination: '',
+    tags: '',
+    app: '',
+    ordering: '',
+    search: ''
+};
+
+function applyFilters() {
+    // Read all filters
+    currentFilters = {
+        method: getValue('filter-method'),
+        path: getValue('filter-path'),
+        models: getValue('filter-models'),
+        auth: getValue('filter-auth'),
+        roles: getValue('filter-roles'),
+        contentType: getValue('filter-content-type'),
+        params: getValue('filter-params'),
+        schema: getValue('filter-schema'),
+        pagination: getValue('filter-pagination'),
+        tags: getValue('filter-tags'),
+        app: getValue('filter-app'),
+        ordering: getValue('filter-ordering'),
+        search: getValue('filter-search'),
+    };
+
+    updateURLParams(currentFilters);
+
+    const cards = document.querySelectorAll('.endpoint-card');
+    let visibleCount = 0;
+
+    cards.forEach(card => {
+        const visible = matchesFilters(card);
+        card.classList.toggle('hidden', !visible);
+        if (visible) visibleCount++;
+    });
+
+    // Collapse viewset sections with no visible cards
+    document.querySelectorAll('.viewset-section').forEach(section => {
+        const visibleCards = section.querySelectorAll('.endpoint-card:not(.hidden)');
+        section.style.display = visibleCards.length === 0 ? 'none' : '';
+    });
+
+    // Collapse app sections with no visible viewsets
+    document.querySelectorAll('.app-section').forEach(app => {
+        const visibleViewsets = app.querySelectorAll('.viewset-section:not([style*="display: none"])');
+        app.style.display = visibleViewsets.length === 0 ? 'none' : '';
+    });
+
+    // Update filter result stats
+    document.querySelector('.filter-results').textContent =
+        `Showing ${visibleCount} of ${cards.length} endpoints`;
+}
+
+function getValue(id) {
+    const el = document.getElementById(id);
+    return el ? el.value.trim().toLowerCase() : '';
+}
+
+function populateAppFilterOptions() {
+    const select = document.getElementById('filter-app');
+    const apps = new Set();
+
+    document.querySelectorAll('.endpoint-card').forEach(card => {
+        const app = card.dataset.app;
+        if (app) apps.add(app);
+    });
+
+    // Convert to sorted array and add as options
+    Array.from(apps).sort().forEach(app => {
+        const opt = document.createElement('option');
+        opt.value = app;
+        opt.textContent = app;
+        select.appendChild(opt);
+    });
+}
+
+function matchesFilters(card) {
+    const d = card.dataset;
+    const f = currentFilters;
+
+    if (f.method && d.method !== f.method) return false;
+    if (f.path && !d.path.includes(f.path)) return false;
+    if (f.app && d.app !== f.app) return false;
+    if (f.auth && d.auth !== f.auth) return false;
+    if (f.pagination && d.pagination !== f.pagination) return false;
+    if (f.search && d.search !== f.search) return false;
+    if (f.ordering && d.ordering !== f.ordering) return false;
+    if (f.models && !d.models.includes(f.models)) return false;
+    if (f.roles && !d.roles.includes(f.roles)) return false;
+    if (f.tags && !d.tags.includes(f.tags)) return false;
+    if (f.contentType && d.contentType !== f.contentType) return false;
+
+    if (f.params && !d.params.includes(f.params)) return false;
+
+    return true;
+}
+
+function clearFilters() {
+    document.querySelectorAll('.filter-input, .filter-select').forEach(el => el.value = '');
+    currentFilters = {
+        method: '', path: '', models: '', auth: '', roles: '', contentType: '',
+        params: '', schema: '', pagination: '', tags: '', app: '', ordering: '', search: ''
+    };
+    applyFilters();
+    updateURLParams(currentFilters);
+}
+
+
+function updateURLParams(filters) {
+    const params = new URLSearchParams();
+    Object.entries(filters).forEach(([k, v]) => {
+        if (v) params.set(k, v);
+    });
+    history.replaceState(null, '', '?' + params.toString());
+}
+
+function loadURLParams() {
+    const params = new URLSearchParams(location.search);
+    params.forEach((v, k) => {
+        const input = document.getElementById(`filter-${k}`);
+        if (input) input.value = v;
+    });
+}
+
+document.addEventListener('DOMContentLoaded', () => {
+    populateAppFilterOptions();
+    loadURLParams();
+    document.querySelectorAll('.filter-input, .filter-select').forEach(input => {
+        input.addEventListener('input', debounce(applyFilters, 250));
+    });
+    applyFilters();
+});
+
+function debounce(func, delay) {
+    let timeout;
+    return function () {
+        clearTimeout(timeout);
+        timeout = setTimeout(func, delay);
+    };
+}
+
+
+
+document.addEventListener('DOMContentLoaded', function() {
+    // Example filter implementation
+    const container = document.getElementById('fullscreen-container');
+
+    // Add filter controls
+    const filterControls = document.createElement('div');
+    filterControls.className = 'filter-controls';
+    filterControls.innerHTML = `
+        <select id="filter-select">
+            <option value="none">No Filter</option>
+            <option value="grayscale">Grayscale</option>
+            <option value="sepia">Sepia</option>
+            <option value="blur">Blur</option>
+        </select>
+    `;
+    container.prepend(filterControls);
+
+    // Apply filter based on selection
+    document.getElementById('filter-select').addEventListener('change', function(e) {
+        container.style.filter = e.target.value === 'none' ? '' : e.target.value + '(100%)';
+    });
+
+    // Your custom filter logic here
+    // Example: Apply initial filter if needed
+    // container.style.filter = 'grayscale(50%)';
+});
+
+document.addEventListener('DOMContentLoaded', () => {
+    const filterPanel = document.getElementById('filterSidebar');
+    const leftSidebar = document.querySelector('.md-sidebar--primary');
+
+    if (filterPanel && leftSidebar) {
+        leftSidebar.innerHTML = ''; // Remove nav if not needed
+        leftSidebar.appendChild(filterPanel);
+        filterPanel.classList.remove('collapsed'); // Make sure it's visible
+    }
+});

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

@@ -0,0 +1,21 @@
+/* ===== ACCESSIBILITY ===== */
+@media (prefers-contrast: high) {
+    :root {
+        --border-color: #000000;
+        --text-secondary: #000000;
+    }
+
+    [data-theme="dark"],
+    [data-md-color-scheme="slate"] {
+        --border-color: #ffffff;
+        --text-secondary: #ffffff;
+    }
+}
+
+@media (prefers-reduced-motion: reduce) {
+    * {
+        animation-duration: 0.01ms !important;
+        animation-iteration-count: 1 !important;
+        transition-duration: 0.01ms !important;
+    }
+}

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

@@ -0,0 +1,11 @@
+/* ===== ANIMATIONS ===== */
+.filter-highlight {
+    background: linear-gradient(135deg, rgba(59, 130, 246, 0.1), rgba(147, 51, 234, 0.1));
+    border-color: var(--accent-primary) !important;
+    animation: highlight-pulse 2s ease-in-out;
+}
+
+@keyframes highlight-pulse {
+    0%, 100% { box-shadow: 0 0 0 0 rgba(59, 130, 246, 0.4); }
+    50% { box-shadow: 0 0 0 10px rgba(59, 130, 246, 0); }
+}

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

@@ -0,0 +1,54 @@
+/* ===== METHOD BADGES ===== */
+.method-badge {
+    position: relative;
+    padding: 6px 12px;
+    font-size: 12px;
+    font-weight: bold;
+    border-radius: 20px;
+    color: white;
+    text-transform: uppercase;
+    overflow: hidden;
+    min-width: 60px;
+    text-align: center;
+    flex-shrink: 0;
+}
+
+.method-badge::before {
+    content: '';
+    position: absolute;
+    top: 0;
+    left: -100%;
+    width: 100%;
+    height: 100%;
+    background: linear-gradient(90deg, transparent, rgba(255, 255, 255, 0.3), transparent);
+    transition: left 0.5s ease;
+}
+
+.method-badge:hover::before {
+    left: 100%;
+}
+
+.method-get {
+    background: linear-gradient(135deg, #10b981, #059669);
+    box-shadow: 0 4px 15px rgba(16, 185, 129, 0.3);
+}
+
+.method-post {
+    background: linear-gradient(135deg, #f59e0b, #d97706);
+    box-shadow: 0 4px 15px rgba(245, 158, 11, 0.3);
+}
+
+.method-put {
+    background: linear-gradient(135deg, #8b5cf6, #7c3aed);
+    box-shadow: 0 4px 15px rgba(139, 92, 246, 0.3);
+}
+
+.method-patch {
+    background: linear-gradient(135deg, #06b6d4, #0891b2);
+    box-shadow: 0 4px 15px rgba(6, 182, 212, 0.3);
+}
+
+.method-delete {
+    background: linear-gradient(135deg, #ef4444, #dc2626);
+    box-shadow: 0 4px 15px rgba(239, 68, 68, 0.3);
+}

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

@@ -0,0 +1,84 @@
+/* ===== BASE STYLES ===== */
+* {
+    box-sizing: border-box;
+}
+
+body {
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+    background: var(--bg-primary);
+    color: var(--text-primary);
+    line-height: 1.6;
+    transition: background-color 0.3s ease, color 0.3s ease;
+    margin: 0;
+    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;
+    }
+}
+