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

{drf_to_mkdoc-0.1.4 → drf_to_mkdoc-0.1.6}/MANIFEST.in

@@ -6,6 +6,7 @@ include pyproject.toml
 recursive-include drf_to_mkdoc/conf *.py
 recursive-include drf_to_mkdoc/utils *.py
 recursive-include drf_to_mkdoc/management *.py
+recursive-include static *
 
 global-exclude *.pyc
 global-exclude *.pyo

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.4
+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.4 → 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.4 → 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.6/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-0.1.6/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-0.1.6/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-0.1.6/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-0.1.6/drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/base.css

@@ -0,0 +1,15 @@
+/* ===== 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;
+}

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

@@ -0,0 +1,48 @@
+/* ===== ENDPOINT CONTENT ===== */
+.endpoint-path {
+    font-family: 'Monaco', 'Menlo', 'SF Mono', monospace;
+    font-weight: 600;
+    color: var(--text-primary);
+    font-size: 15px;
+    margin-bottom: 8px;
+    word-break: break-all;
+    background: var(--bg-primary);
+    padding: 12px;
+    border-radius: 8px;
+    border: 1px solid var(--border-color);
+    flex: 1;
+    min-width: 0;
+}
+
+.endpoint-description {
+    color: var(--text-secondary);
+    font-size: 14px;
+    margin-bottom: 12px;
+    line-height: 1.5;
+}
+
+.related-models {
+    margin-bottom: 12px;
+}
+
+.related-models-label {
+    font-size: 12px;
+    color: var(--text-secondary);
+    margin-bottom: 4px;
+}
+
+.models-list {
+    display: flex;
+    flex-wrap: wrap;
+    gap: 4px;
+}
+
+.model-badge {
+    background: var(--bg-primary);
+    color: var(--text-primary);
+    padding: 2px 6px;
+    border-radius: 4px;
+    font-size: 11px;
+    font-family: monospace;
+    border: 1px solid var(--border-color);
+}

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

@@ -0,0 +1,75 @@
+/* ===== ENDPOINTS GRID ===== */
+.endpoints-grid {
+    display: grid;
+    grid-template-columns: 1fr;
+    gap: 16px;
+    margin: 24px 0;
+    transition: all 0.3s ease;
+    width: 100%;
+}
+
+.endpoints-grid.filtering {
+    opacity: 0.7;
+}
+
+/* ===== ENDPOINT CARDS ===== */
+.endpoint-card {
+    position: relative;
+    display: flex;
+    align-items: center;
+    gap: 16px;
+    padding: 20px;
+    background: var(--bg-secondary);
+    border: 1px solid var(--border-color);
+    border-radius: 12px;
+    transition: all 0.3s ease;
+    text-decoration: none;
+    color: var(--text-primary);
+    box-shadow: var(--shadow);
+    overflow: hidden;
+    width: 100%;
+    box-sizing: border-box;
+}
+
+.endpoint-card::before {
+    content: '';
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    bottom: 0;
+    background: linear-gradient(135deg, rgba(59, 130, 246, 0.1), rgba(147, 51, 234, 0.1));
+    opacity: 0;
+    transition: opacity 0.3s ease;
+    z-index: 1;
+}
+
+.endpoint-card:hover::before {
+    opacity: 1;
+}
+
+.endpoint-card:hover {
+    transform: translateY(-2px);
+    box-shadow: var(--shadow-hover);
+}
+
+.endpoint-card:focus {
+    outline: 2px solid var(--accent-primary);
+    outline-offset: 2px;
+}
+
+.endpoint-card.hidden {
+    opacity: 0;
+    transform: scale(0.95);
+    pointer-events: none;
+    position: absolute;
+    height: 0;
+    margin: 0;
+    padding: 0;
+    border: none;
+}
+
+.endpoint-card > * {
+    position: relative;
+    z-index: 2;
+}