django-spire 0.23.7__tar.gz → 0.23.8__tar.gz

django_spire-0.23.8/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: django-spire
+Version: 0.23.8
+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.
+        
+        Permission is hereby granted, free of charge, to any person
+        obtaining a copy of this software and associated documentation
+        files (the "Software"), to deal in the Software without
+        restriction, including without limitation the rights to use,
+        copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the
+        Software is furnished to do so, subject to the following
+        conditions:
+        
+        The above copyright notice and this permission notice shall be
+        included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+        OTHER DEALINGS IN THE SOFTWARE.
+        
+Keywords: portal,cmms,spire,django,backend,frontend,javascript,active server pages
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: beautifulsoup4>=4.14.2
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: botocore>=1.34.0
+Requires-Dist: crispy-bootstrap5==2024.10
+Requires-Dist: dandy>=1.3.5
+Requires-Dist: django>=5.1.8
+Requires-Dist: django-crispy-forms==2.3
+Requires-Dist: django-glue>=0.8.1
+Requires-Dist: django-sendgrid-v5
+Requires-Dist: django-storages==1.14.5
+Requires-Dist: docutils
+Requires-Dist: faker
+Requires-Dist: marko==2.1.4
+Requires-Dist: markitdown[docx,pdf]==0.1.2
+Requires-Dist: psycopg2
+Requires-Dist: pydantic
+Requires-Dist: Pygments
+Requires-Dist: Pillow==11.2.1
+Requires-Dist: python-dateutil
+Requires-Dist: robit>=0.4.8
+Requires-Dist: typing_extensions
+Requires-Dist: twilio
+Provides-Extra: development
+Requires-Dist: build; extra == "development"
+Requires-Dist: django-browser-reload; extra == "development"
+Requires-Dist: django-debug-toolbar; extra == "development"
+Requires-Dist: django-watchfiles; extra == "development"
+Requires-Dist: pip; extra == "development"
+Requires-Dist: playwright; extra == "development"
+Requires-Dist: pyinstrument; extra == "development"
+Requires-Dist: pyrefly; extra == "development"
+Requires-Dist: pytest; extra == "development"
+Requires-Dist: pytest-django; extra == "development"
+Requires-Dist: pytest-playwright; extra == "development"
+Requires-Dist: setuptools; extra == "development"
+Requires-Dist: twine; extra == "development"
+Provides-Extra: documentation
+Requires-Dist: mkdocs; extra == "documentation"
+Requires-Dist: markdown-exec[ansi]; extra == "documentation"
+Requires-Dist: mkdocs-include-markdown-plugin; extra == "documentation"
+Requires-Dist: mkdocs-material; extra == "documentation"
+Requires-Dist: mkdocs-table-reader-plugin; extra == "documentation"
+Requires-Dist: mkdocstrings-python; extra == "documentation"
+Requires-Dist: mkdocs-gen-files; extra == "documentation"
+Requires-Dist: mkdocs-literate-nav; extra == "documentation"
+Requires-Dist: mkdocs-section-index; extra == "documentation"
+Requires-Dist: openpyxl; extra == "documentation"
+Dynamic: license-file
+
+# Django Spire
+
+![Build](https://img.shields.io/github/actions/workflow/status/stratusadv/django-spire/ci.yml)
+![Python Versions](https://img.shields.io/pypi/pyversions/django-spire)
+![PyPI Version](https://img.shields.io/pypi/v/django-spire)
+![Downloads](https://img.shields.io/pypi/dm/django-spire)
+
+## Purpose
+
+Make Django application development modular, extensible, and configurable.
+
+## Getting Started
+
+Please refer to our [website](https://django-spire.stratusadv.com) for detailed setup, module configuration, and usage examples.
+
+<p align="center">
+    <a href="https://django-spire.stratusadv.com">
+        <img alt="Dandy Logo" src="https://django-spire.stratusadv.com/static/img/django_spire_logo_512.png"/>
+    </a>
+</p>

django_spire-0.23.8/django_spire/ai/admin.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+from django import forms
+from django.contrib import admin
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.http import urlencode
+
+from django_spire.ai import models
+from django_spire.ai.mixins import AiUsageAdminMixin
+from django_spire.core.forms.widgets import JsonTreeWidget
+
+
+@admin.register(models.AiUsage)
+class AiUsageAdmin(AiUsageAdminMixin):
+    list_display = (
+        'recorded_date',
+        'was_successful',
+        'event_count',
+        'token_usage',
+        'run_time_seconds_formatted',
+        'view_interactions_link',
+        'view_successful_interactions_link',
+        'view_failed_interactions_link'
+    )
+    search_fields = ('recorded_date',)
+    ordering = ('-recorded_date',)
+
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
+        return [field.name for field in self.model._meta.fields]
+
+    def view_interactions_link(
+        self,
+        ai_usage: models.AiUsage,
+        was_successful: bool | None = None
+    ) -> str:
+        was_successful_filter = '' if was_successful is None else f'&was_successful__exact={int(was_successful)}'
+
+        url = (
+            reverse("admin:django_spire_ai_aiinteraction_changelist")
+            + "?"
+            + urlencode({"ai_usage__id": f"{ai_usage.id}"})
+            + was_successful_filter
+        )
+
+        if was_successful is None:
+            interactions_count = ai_usage.interactions.count()
+        elif was_successful:
+            interactions_count = ai_usage.interactions.filter(was_successful=True).count()
+        else:
+            interactions_count = ai_usage.interactions.filter(was_successful=False).count()
+
+        return format_html(
+            f'<a href="{url}">{interactions_count} Interactions</a>'
+        )
+
+    view_interactions_link.short_description = "All"
+
+    def view_successful_interactions_link(
+        self,
+        ai_usage: models.AiUsage
+    ) -> str:
+        return self.view_interactions_link(ai_usage, was_successful=True)
+
+    view_successful_interactions_link.short_description = "Successful"
+
+    def view_failed_interactions_link(
+        self,
+        ai_usage: models.AiUsage
+    ) -> str:
+        return self.view_interactions_link(ai_usage, was_successful=False)
+
+    view_failed_interactions_link.short_description = "Failed"
+
+
+class AiInteractionModelForm(forms.ModelForm):
+    interaction = forms.JSONField(widget=JsonTreeWidget)
+
+    class Meta:
+        model = models.AiInteraction
+        fields = '__all__'
+
+
+@admin.register(models.AiInteraction)
+class AiInteractionAdmin(AiUsageAdminMixin):
+    form = AiInteractionModelForm
+
+    list_display = (
+        'actor',
+        'callable_name',
+        'was_successful',
+        'event_count',
+        'token_usage',
+        'run_time_seconds_formatted',
+        'created_datetime',
+    )
+    list_filter = ('module_name', 'callable_name', 'was_successful')
+    search_fields = ('actor', 'user_email', 'user_first_name', 'user_last_name', 'module_name', 'callable_name')
+    ordering = ('-created_datetime',)
+
+    readonly_fields = [
+        'actor',
+        'created_datetime',
+        'module_name',
+        'callable_name',
+        'was_successful',
+        'user',
+        'user_email',
+        'user_first_name',
+        'user_last_name',
+        'exception',
+        'stack_trace',
+    ]
+    fields = [
+        'actor',
+        'user',
+        'created_datetime',
+        'module_name',
+        'callable_name',
+        'was_successful',
+        'interaction',
+        'user_email',
+        'user_first_name',
+        'user_last_name',
+        'exception',
+        'stack_trace',
+    ]

django_spire-0.23.8/django_spire/ai/chat/apps.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class AiChatConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_spire.ai.chat'
+    label = 'django_spire_ai_chat'
+    MODEL_PERMISSIONS = (
+        {
+            'name': 'ai_chat',
+            'verbose_name': 'AI Chat',
+            'model_class_path': 'django_spire.ai.chat.models.Chat',
+            'is_proxy_model': False,
+        },
+    )
+
+    REQUIRED_APPS = ('django_spire_ai', 'django_spire_ai_context')
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire-0.23.8/django_spire/ai/chat/templates/django_spire/ai/chat/widget/dialog_widget.html

@@ -0,0 +1,126 @@
+{% extends 'django_spire/speech/speech_recognition.html' %}
+
+{% block speech_recognition_content %}
+    <div
+        class="row"
+        x-data="{
+            chat_id: '{{ chat.id|default:'0' }}',
+            chat_name: '{{ chat.name_shortened|default:'New Chat'|escapejs }}',
+            message_body: '',
+            request_message_view: new ViewGlue('{% url "django_spire:ai:chat:message:request:new" %}'),
+
+            init() {
+                if (this.chat_id && this.chat_id !== '0' && this.chat_id !== '') {
+                    this.load_messages()
+                }
+
+                setTimeout(() => {
+                    if (this.$refs.target_div) {
+                        this.smooth_scroll_to_bottom()
+                    }
+                }, 1500)
+
+                this.speech_recognition.onresult = () => {
+                    this.message_body = this.speech_transcript
+                    this.send_chat({message_body: this.message_body, synthesis_speech_for_response: true})
+                }
+            },
+
+            load_messages() {
+                let load_messages_view = new ViewGlue(`/django_spire/ai/chat/message/load/chat/${this.chat_id}/`)
+                load_messages_view.render_insert_adjacent(this.$refs.target_div, {})
+            },
+
+            smooth_scroll_to_bottom() {
+                let target = this.$refs.target_div
+                let start = target.scrollTop
+                let end = target.scrollHeight - target.clientHeight
+                let duration = 400
+                let start_time = performance.now()
+
+                function animate(current_time) {
+                    let elapsed = current_time - start_time
+                    let progress = Math.min(elapsed / duration, 1)
+                    let ease = progress * (2 - progress)
+
+                    target.scrollTop = start + (end - start) * ease
+
+                    if (progress < 1) {
+                        requestAnimationFrame(animate)
+                    }
+                }
+
+                requestAnimationFrame(animate)
+            },
+
+            async send_chat({message_body = '', synthesis_speech_for_response = false}) {
+                if (message_body !== '') {
+                    let was_new_chat = (this.chat_id === '0' || this.chat_id === 0 || this.chat_id === '')
+
+                    let response_html = await this.request_message_view.render_insert_adjacent(
+                        this.$refs.target_div,
+                        {
+                            chat_id: this.chat_id,
+                            message_body: message_body,
+                            synthesis_speech: synthesis_speech_for_response
+                        }
+                    )
+
+                    if (was_new_chat) {
+                        this.chat_name = message_body.length > 24 ? message_body.substring(0, 21) + '...' : message_body
+
+                        let message_element = this.$refs.target_div.querySelector('[data-message-chat-id]')
+
+                        if (message_element) {
+                            this.chat_id = message_element.dataset.messageChatId
+                            $dispatch('new-chat-created', {chat_id: parseInt(this.chat_id)})
+                        }
+                    }
+
+                    this.message_body = ''
+                    $dispatch('chat-loaded')
+                }
+            },
+
+            speak_text(text) {
+                if ('speechSynthesis' in window) {
+                    let utterance = new SpeechSynthesisUtterance(text)
+                    window.speechSynthesis.speak(utterance)
+                }
+            }
+        }"
+        @send-message.window="send_chat({message_body: $event.detail.message_body})" @speak.window="speak_text($event.detail.text)"
+    >
+        <div class="col-12">
+            <div class="row border-bottom px-0">
+                <div class="col text-center pb-2" x-text="chat_name">
+                </div>
+            </div>
+
+            <div class="row mb-3">
+                <div class="col-12 overflow-auto p-4" style="{{ dialog_height|default:'height: calc(100vh - 90px - var(--app-top-navigation-height));' }}" x-ref="target_div"></div>
+            </div>
+
+            <div class="row pe-5">
+                <div class="col-auto text-center ps-2 pe-1">
+                    <button @click="start_listening()" class="btn btn-app-primary-outlined" x-show="!speech_listening">
+                        <i class="bi bi-mic"></i>
+                    </button>
+                    <button @click="stop_listening()" class="btn btn-app-danger" x-show="speech_listening">
+                        <i class="bi bi-mic-fill"></i>
+                    </button>
+                </div>
+
+                <div class="col text-center px-1">
+                    <input @keyup.enter="send_chat({message_body: message_body})" autocomplete="off" class="form-control" name="request_message" type="text" x-init="$el.focus()" x-model="message_body">
+                </div>
+
+                <div class="col-auto text-center ps-1 pe-2">
+                    <button @click="send_chat({message_body: message_body})" class="btn btn-app-primary">
+                        <i class="bi bi-send"></i>
+                    </button>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

django_spire-0.23.8/django_spire/ai/chat/tests/factories.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.ai.chat.models import Chat
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+
+
+def create_test_chat(user: User) -> Chat:
+    return Chat.objects.create(
+        user=user,
+        name='New Exciting Chat!'
+    )

django_spire-0.23.8/django_spire/ai/chat/tests/test_controller.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from django.contrib.auth.models import Permission, User
+from django.test import RequestFactory
+
+from django_spire.ai.chat.auth.controller import BaseAiChatAuthController
+from django_spire.core.tests.test_cases import BaseTestCase
+
+
+class BaseAiChatAuthControllerTests(BaseTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.factory = RequestFactory()
+        self.request = self.factory.get('/')
+        self.request.user = self.super_user
+
+    def test_can_delete_with_permission(self) -> None:
+        permission = Permission.objects.get(codename='delete_chat')
+        self.super_user.user_permissions.add(permission)
+
+        self.super_user = type(self.super_user).objects.get(pk=self.super_user.pk)
+        self.request.user = self.super_user
+
+        controller = BaseAiChatAuthController(self.request)
+
+        assert controller.can_delete() is True
+
+    def test_can_delete_without_permission(self) -> None:
+        regular_user = User.objects.create_user(
+            username='regular_user',
+            password='testpass123'  # noqa: S106
+        )
+
+        request = self.factory.get('/')
+        request.user = regular_user
+
+        controller = BaseAiChatAuthController(request)
+
+        assert controller.can_delete() is False
+
+    def test_controller_has_request(self) -> None:
+        controller = BaseAiChatAuthController(self.request)
+
+        assert controller.request == self.request