django-spire 0.17.3__py3-none-any.whl → 0.17.5__py3-none-any.whl

django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.17.3'
+__VERSION__ = '0.17.5'
 
 
 AI_CHAT_WORKFLOW_SENDER_SETTINGS_NAME = 'AI_CHAT_WORKFLOW_NAME'

django_spire/contrib/progress/__init__.py

@@ -0,0 +1,10 @@
+from django_spire.contrib.progress.mixins import ProgressTrackingMixin
+from django_spire.contrib.progress.tracker import ProgressTracker
+from django_spire.contrib.progress.views import sse_stream_view
+
+
+__all__ = [
+    'ProgressTracker',
+    'ProgressTrackingMixin',
+    'sse_stream_view',
+]

django_spire/contrib/progress/mixins.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.contrib.progress.tracker import ProgressTracker
+
+if TYPE_CHECKING:
+    from typing import Any
+
+
+class ProgressTrackingMixin:
+    _tracker: ProgressTracker | None = None
+
+    def get_tracker_key(self) -> str:
+        raise NotImplementedError
+
+    @property
+    def tracker(self) -> ProgressTracker:
+        if self._tracker is None:
+            key = self.get_tracker_key()
+            self._tracker = ProgressTracker(key)
+
+        return self._tracker
+
+    def update_progress(
+        self,
+        step: str,
+        message: str,
+        progress: int,
+        **kwargs: Any
+    ) -> None:
+        self.tracker.update(step, message, progress, **kwargs)
+
+    def progress_error(self, message: str) -> None:
+        self.tracker.error(message)

django_spire/contrib/progress/static/django_spire/js/contrib/progress/progress.js

@@ -0,0 +1,62 @@
+class ProgressStream {
+    constructor(url, config = {}) {
+        this.url = url;
+        this.event_source = null;
+        this.config = {
+            on_update: config.on_update || (() => {}),
+            on_complete: config.on_complete || (() => {}),
+            on_error: config.on_error || (() => {}),
+            redirect_on_complete: config.redirect_on_complete || null,
+            redirect_delay: config.redirect_delay || 1000
+        };
+    }
+
+    start() {
+        this.event_source = new EventSource(this.url);
+
+        this.event_source.onmessage = (event) => {
+            const data = JSON.parse(event.data);
+
+            this.config.on_update(data);
+
+            if (data.step === 'error') {
+                this.config.on_error(data);
+                this.stop();
+
+                return;
+            }
+
+            if (data.progress >= 100) {
+                this.config.on_complete(data);
+                this.stop();
+
+                if (this.config.redirect_on_complete) {
+                    setTimeout(() => {
+                        window.location.href = this.config.redirect_on_complete;
+                    }, this.config.redirect_delay);
+                }
+            }
+        };
+
+        this.event_source.onerror = (error) => {
+            console.error('ProgressStream error:', error);
+
+            this.config.on_error({
+                step: 'error',
+                message: 'Connection error',
+                progress: 0
+            });
+
+            this.stop();
+        };
+    }
+
+    stop() {
+        if (this.event_source) {
+            this.event_source.close();
+            this.event_source = null;
+        }
+    }
+}
+
+window.ProgressStream = ProgressStream;

django_spire/contrib/progress/templates/django_spire/contrib/progress/card/card.html

@@ -0,0 +1,81 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    <i class="bi bi-magic"></i>
+    {% block progress_card_title %}Processing{% endblock %}
+{% endblock %}
+
+{% block card_title_content %}
+    <div
+        data-stream-url="{% block progress_stream_url %}{% endblock %}"
+        data-redirect-url="{% block progress_redirect_url %}{% endblock %}"
+        data-redirect-delay="{% block progress_redirect_delay %}1000{% endblock %}"
+        x-data="{
+            step: 'starting',
+            message: 'Initializing...',
+            progress: 0,
+            has_error: false,
+            stream: null,
+            init() {
+                const stream_url = this.$el.dataset.streamUrl;
+                const redirect_url = this.$el.dataset.redirectUrl;
+                const redirect_delay = parseInt(this.$el.dataset.redirectDelay);
+
+                this.stream = new ProgressStream(stream_url, {
+                    on_update: (data) => {
+                        this.step = data.step;
+                        this.message = data.message;
+                        this.progress = data.progress;
+                    },
+                    on_complete: (data) => {},
+                    on_error: (data) => {
+                        this.has_error = true;
+                        this.message = data.message;
+                    },
+                    redirect_on_complete: redirect_url,
+                    redirect_delay: redirect_delay
+                });
+                this.stream.start();
+            }
+        }"
+    >
+        <div class="row g-3">
+            <div class="col-12" x-show="!has_error">
+                <div class="d-flex justify-content-between align-items-center mb-2">
+                    <span class="fs-6" x-text="message"></span>
+                    {% include 'django_spire/badge/accent_badge.html' with x_badge_text="progress + '%'" %}
+                </div>
+                <div class="progress" style="height: 8px;">
+                    <div
+                        class="progress-bar bg-app-accent"
+                        role="progressbar"
+                        :style="'width: ' + progress + '%'"
+                        :aria-valuenow="progress"
+                        aria-valuemin="0"
+                        aria-valuemax="100"
+                    ></div>
+                </div>
+            </div>
+
+            <div class="col-12" x-show="!has_error">
+                <p class="text-app-secondary mb-0 fs-7">
+                    {% block progress_wait_message %}Processing your request. This may take a moment.{% endblock %}
+                </p>
+            </div>
+
+            <div class="col-12" x-show="has_error" x-cloak>
+                <div class="row g-2">
+                    <div class="col-12">
+                        {% include 'django_spire/element/attribute_element.html' with attribute_title='Error' %}
+                        <span class="fs-6 text-app-danger" x-text="message"></span>
+                    </div>
+                    <div class="col-12">
+                        {% block progress_error_button %}
+                            {% include 'django_spire/button/primary_button.html' with button_text='Go Back' %}
+                        {% endblock %}
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

django_spire/contrib/progress/templates/django_spire/contrib/progress/modal/content.html

@@ -0,0 +1,90 @@
+{% extends 'django_spire/modal/content/modal_title_content.html' %}
+
+{% block modal_content_title %}
+    <i class="bi bi-magic"></i>
+    {% block progress_modal_title %}Processing{% endblock %}
+{% endblock %}
+
+{% block modal_content_close_button %}
+{% endblock %}
+
+{% block modal_content_content %}
+    <div
+        data-stream-url="{% block progress_stream_url %}{% endblock %}"
+        data-redirect-url="{% block progress_redirect_url %}{% endblock %}"
+        data-redirect-delay="{% block progress_redirect_delay %}1000{% endblock %}"
+        x-data="{
+            step: 'starting',
+            message: 'Initializing...',
+            progress: 0,
+            has_error: false,
+            stream: null,
+            init() {
+                const stream_url = this.$el.dataset.streamUrl;
+                const redirect_url = this.$el.dataset.redirectUrl;
+                const redirect_delay = parseInt(this.$el.dataset.redirectDelay);
+
+                this.stream = new ProgressStream(stream_url, {
+                    on_update: (data) => {
+                        this.step = data.step;
+                        this.message = data.message;
+                        this.progress = data.progress;
+                    },
+                    on_complete: (data) => {
+                        setTimeout(() => {
+                            close_modal();
+                        }, 500);
+                    },
+                    on_error: (data) => {
+                        this.has_error = true;
+                        this.message = data.message;
+                    },
+                    redirect_on_complete: redirect_url,
+                    redirect_delay: redirect_delay
+                });
+                this.stream.start();
+            }
+        }"
+    >
+        <div class="row g-3">
+            <div class="col-12" x-show="!has_error">
+                <div class="d-flex justify-content-between align-items-center mb-2">
+                    <span class="fs-6" x-text="message"></span>
+                    {% include 'django_spire/badge/accent_badge.html' with x_badge_text="progress + '%'" %}
+                </div>
+                <div class="progress" style="height: 8px;">
+                    <div
+                        class="progress-bar bg-app-accent"
+                        role="progressbar"
+                        :style="'width: ' + progress + '%'"
+                        :aria-valuenow="progress"
+                        aria-valuemin="0"
+                        aria-valuemax="100"
+                    ></div>
+                </div>
+            </div>
+
+            <div class="col-12" x-show="!has_error">
+                <p class="text-app-secondary mb-0 fs-7">
+                    {% block progress_wait_message %}We are processing your request. This may take a moment.{% endblock %}
+                </p>
+            </div>
+
+            <div class="col-12" x-show="has_error" x-cloak>
+                <div class="row g-2">
+                    <div class="col-12">
+                        {% include 'django_spire/element/attribute_element.html' with attribute_title='Error' %}
+                        <span class="fs-6 text-app-danger" x-text="message"></span>
+                    </div>
+                    <div class="col-12">
+                        <span @click="close_modal()">
+                            {% block progress_error_button %}
+                                {% include 'django_spire/button/primary_button.html' with button_text='Close' %}
+                            {% endblock %}
+                        </span>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

django_spire/contrib/progress/tracker.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.core.cache import cache
+
+if TYPE_CHECKING:
+    from typing import Any
+
+
+class ProgressTracker:
+    def __init__(self, key: str, timeout: int = 300) -> None:
+        self.key = f'progress_tracker_{key}'
+        self.timeout = timeout
+
+    def update(
+        self,
+        step: str,
+        message: str,
+        progress: int,
+        **kwargs: Any
+    ) -> None:
+        data = {
+            'step': step,
+            'message': message,
+            'progress': progress,
+            **kwargs
+        }
+
+        cache.set(self.key, data, timeout=self.timeout)
+
+    def get(self) -> dict[str, Any] | None:
+        return cache.get(self.key)
+
+    def clear(self) -> None:
+        cache.delete(self.key)
+
+    def error(self, message: str) -> None:
+        self.update('error', message, 0)

django_spire/contrib/progress/views.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import json
+import time
+
+from typing import TYPE_CHECKING
+
+from django.http import StreamingHttpResponse
+
+from django_spire.contrib.progress.tracker import ProgressTracker
+
+if TYPE_CHECKING:
+    from typing import Callable
+
+
+def sse_stream_view(
+    key: str,
+    interval: float = 0.5,
+    should_continue: Callable[[dict], bool] | None = None
+) -> StreamingHttpResponse:
+    def event_stream() -> None:
+        tracker = ProgressTracker(key)
+        previous_progress = -1
+
+        while True:
+            time.sleep(interval)
+            data = tracker.get()
+
+            if data:
+                current_progress = data.get('progress', 0)
+
+                if current_progress != previous_progress:
+                    yield f'data: {json.dumps(data)}\n\n'
+                    previous_progress = current_progress
+
+                if should_continue and not should_continue(data):
+                        break
+
+                if current_progress >= 100 or data.get('step') == 'error':
+                    break
+
+    response = StreamingHttpResponse(
+        event_stream(),
+        content_type='text/event-stream'
+    )
+
+    response['Cache-Control'] = 'no-cache'
+    response['X-Accel-Buffering'] = 'no'
+
+    return response

django_spire/core/templates/django_spire/badge/base_badge.html

@@ -4,5 +4,11 @@
         {{ badge_class|default:'fs--1' }}
     "
 >
-    {{ badge_text }}
+    {% if badge_text %}
+        {{ badge_text }}
+    {% endif %}
+
+    {% if x_badge_text %}
+        <span x-text="{{ x_badge_text }}"></span>
+    {% endif %}
 </span>

{django_spire-0.17.3.dist-info → django_spire-0.17.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.17.3
+Version: 0.17.5
 Summary: A project for Django Spire
 Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
 License: Copyright (c) 2024 Stratus Advanced Technologies and Contributors.
@@ -48,7 +48,7 @@ License-File: LICENSE.md
 Requires-Dist: boto3>=1.34.0
 Requires-Dist: botocore>=1.34.0
 Requires-Dist: crispy-bootstrap5==2024.10
-Requires-Dist: dandy==1.1.2
+Requires-Dist: dandy==1.1.3
 Requires-Dist: django>=5.1.8
 Requires-Dist: django-crispy-forms==2.3
 Requires-Dist: django-glue>=0.8.1

{django_spire-0.17.3.dist-info → django_spire-0.17.5.dist-info}/RECORD

@@ -1,6 +1,6 @@
 django_spire/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/conf.py,sha256=EYC1hXqYqheYrb_b6Q93LrSgNl91JV633E4N5j-KGTo,1012
-django_spire/consts.py,sha256=km3fdksyNcELR-UlQrrS0G1_KVwTiVaiqauBjKMlpHg,390
+django_spire/consts.py,sha256=1kja89XlrvvNvZp5jPCCpGIpORx633GOJvBWrbHutbo,390
 django_spire/exceptions.py,sha256=L5ndRO5ftMmh0pHkO2z_NG3LSGZviJ-dDHNT73SzTNw,48
 django_spire/settings.py,sha256=tGxgEri3TQRBaiwX7YRcWifMf_g1xv1RznplFR6zZnI,821
 django_spire/urls.py,sha256=mKeZszb5U4iIGqddMb5Tt5fRC72U2wABEOi6mvOfEBU,656
@@ -329,6 +329,14 @@ django_spire/contrib/pagination/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TI
 django_spire/contrib/pagination/templatetags/pagination_tags.py,sha256=xE3zTDJZDdDvWf6D7fMyg_Vi0PW37OA3aZxCjOHDp4I,1173
 django_spire/contrib/performance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/contrib/performance/decorators.py,sha256=xOjXX-3FVOEWqr2TTTqdh4lkIhmHTlROevOVgXDeyt8,507
+django_spire/contrib/progress/__init__.py,sha256=zfB13CHEfaGLA8ILNTmePG2efwBygpitqxA9CDplc0U,292
+django_spire/contrib/progress/mixins.py,sha256=970sYbaZq2WAey-kAVED5hskQFXNh4WeCBIgNJLfdFU,834
+django_spire/contrib/progress/tracker.py,sha256=VtzcD0pxCsq736RHPXJfspfC7qNdjb74Cl6VKI7U3Iw,870
+django_spire/contrib/progress/views.py,sha256=bBEbTktWMlizzrdchPn6G4EEnDqc64bNH7Vt005XF2E,1268
+django_spire/contrib/progress/static/django_spire/css/contrib/progress/progress.css,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_spire/contrib/progress/static/django_spire/js/contrib/progress/progress.js,sha256=2Zuwiu1nWJpghzU-6fmf6s4qKLLyiZUcAJwB9-v5xWI,1701
+django_spire/contrib/progress/templates/django_spire/contrib/progress/card/card.html,sha256=2Ajv0UBJEGwc4InVe69aLe2u4K56yh2JAuvO6uH24j8,3353
+django_spire/contrib/progress/templates/django_spire/contrib/progress/modal/content.html,sha256=oZ7mOxzro5809wSHLe4A90PonAqcr_eVawR_xHKXIt8,3682
 django_spire/contrib/queryset/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/contrib/queryset/enums.py,sha256=FhrwaEZ8Ql3AnImDleJFonp11-ObCZT24bC5fCCVBxE,132
 django_spire/contrib/queryset/filter_tools.py,sha256=o7OBB3Jjtyoj7aaWspkFKS2bv0BeMIigXz7DVvt6Ueo,1087
@@ -549,7 +557,7 @@ django_spire/core/templates/django_spire/maintenance.html,sha256=T4dwFh8jyCxxVaz
 django_spire/core/templates/django_spire/accordion/accordion.html,sha256=12a9S-8Be2m4-SozdVQDm7XwlYeD75MD5VMyJkwYq-U,566
 django_spire/core/templates/django_spire/accordion/view_glue_accordion.html,sha256=QrLebgX726YVX2EBbM9wVhB0B-IsWcmA2EbSd3C2lUM,869
 django_spire/core/templates/django_spire/badge/accent_badge.html,sha256=1Ib4sZ8JUkVx8seLWyqHhzt2Fosc5U3rTZecv04h_jU,103
-django_spire/core/templates/django_spire/badge/base_badge.html,sha256=RrKqN4oaz3BZ2AjKG_NQyUdNzyPsrUFMQIhKgFJ5tNI,176
+django_spire/core/templates/django_spire/badge/base_badge.html,sha256=t1oLpIIi0aLGMu5ySDZYy9fD-Z8W6mZjuNYhJh0q314,313
 django_spire/core/templates/django_spire/badge/danger_badge.html,sha256=CgPL64GZxPbkGW9tDh2WPsPkURDFDjTqRbSOG2Kc_6k,103
 django_spire/core/templates/django_spire/badge/primary_badge.html,sha256=AsZZiVRWlHzgLDcocf2tWr7Q0Z3oADj2-jilQpnZ_Sc,104
 django_spire/core/templates/django_spire/badge/primary_outlined_badge.html,sha256=WA1EX5-ovSm7Hs6h7sVpMdNf9gF5db_pW2TFni5D_p4,132
@@ -1097,8 +1105,8 @@ django_spire/theme/urls/page_urls.py,sha256=S8nkKkgbhG3XHI3uMUL-piOjXIrRkuY2UlM_
 django_spire/theme/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/theme/views/json_views.py,sha256=W1khC2K_EMbEzAFmMxC_P76_MFnkRH4-eVdodrRfAhw,1904
 django_spire/theme/views/page_views.py,sha256=pHr8iekjtR99xs7w1taj35HEo133Svq1dvDD0y0VL1c,3933
-django_spire-0.17.3.dist-info/licenses/LICENSE.md,sha256=tlTbOtgKoy-xAQpUk9gPeh9O4oRXCOzoWdW3jJz0wnA,1091
-django_spire-0.17.3.dist-info/METADATA,sha256=tIwxrqNEAbyJ9jbgwEB6gOHWJB4NuGF2G0IwLi3GqoQ,4936
-django_spire-0.17.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-django_spire-0.17.3.dist-info/top_level.txt,sha256=xf3QV1e--ONkVpgMDQE9iqjQ1Vg4--_6C8wmO-KxPHQ,13
-django_spire-0.17.3.dist-info/RECORD,,
+django_spire-0.17.5.dist-info/licenses/LICENSE.md,sha256=tlTbOtgKoy-xAQpUk9gPeh9O4oRXCOzoWdW3jJz0wnA,1091
+django_spire-0.17.5.dist-info/METADATA,sha256=2i3NkfAg8_fKKsLY33UwdVxFfGavbwYkcRLvJbN8xAk,4936
+django_spire-0.17.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+django_spire-0.17.5.dist-info/top_level.txt,sha256=xf3QV1e--ONkVpgMDQE9iqjQ1Vg4--_6C8wmO-KxPHQ,13
+django_spire-0.17.5.dist-info/RECORD,,