django-spire 0.18.3__tar.gz → 0.19.1__tar.gz

django_spire-0.19.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: django-spire
+Version: 0.19.1
+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.1
+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: pyinstrument; extra == "development"
+Requires-Dist: pyrefly; extra == "development"
+Requires-Dist: pytest; 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.19.1/README.md

@@ -0,0 +1,20 @@
+# 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.19.1/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.19.1/django_spire/ai/chat/apps.py

@@ -0,0 +1,23 @@
+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.19.1/django_spire/ai/chat/intelligence/decoders/tools.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from typing import Callable, TYPE_CHECKING
+
+from dandy import Decoder
+
+from django_spire.auth.controller.controller import AppAuthController
+from django_spire.knowledge.intelligence.workflows.knowledge_workflow import knowledge_search_workflow
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def generate_intent_decoder(
+    request: WSGIRequest,
+    default_callable: Callable | None = None
+) -> Decoder:
+    intent_dict = {}
+
+    if AppAuthController(app_name='knowledge', request=request).can_view():
+        intent_dict['The user is looking for information or knowledge on something.'] = knowledge_search_workflow
+
+    if default_callable is not None:
+        intent_dict['None of the above choices match the user\'s intent'] = default_callable
+
+    return Decoder(
+        mapping_keys_description='Intent of the User\'s Request',
+        mapping=intent_dict
+    )

django_spire-0.19.1/django_spire/ai/chat/intelligence/prompts.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dandy import Prompt
+
+from django_spire.ai.context.intelligence.prompts.organization_prompts import (
+    organization_info_prompt
+)
+
+
+def chat_system_prompt() -> Prompt:
+    return (
+        Prompt()
+        .text(
+            'You are a chat assistant, please use the organization information below for answering questions.'
+        )
+        .line_break()
+        .prompt(organization_info_prompt())
+        .line_break()
+        .text('Make sure to follow the rules below')
+        .list(
+            [
+                'Do not talk about being an AI at all to maintain the illusion of being a human assistant.',
+            ]
+        )
+    )

django_spire-0.19.1/django_spire/ai/chat/intelligence/workflows/chat_workflow.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Callable
+
+from dandy import Bot
+from dandy.recorder import recorder_to_html_file
+
+from django_spire.ai.chat.intelligence.decoders.tools import generate_intent_decoder
+from django_spire.ai.chat.message_intel import BaseMessageIntel, DefaultMessageIntel
+from django_spire.ai.decorators import log_ai_interaction_from_recorder
+
+if TYPE_CHECKING:
+    from dandy.llm.request.message import MessageHistory
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def SpireChatWorkflow(
+    request: WSGIRequest,
+    user_input: str,
+    message_history: MessageHistory | None = None
+) -> BaseMessageIntel:
+    return chat_workflow(
+        request=request,
+        user_input=user_input,
+        message_history=message_history
+    )
+
+
+def default_chat_response(
+    request: WSGIRequest,
+    user_input: str,
+    message_history: MessageHistory | None = None
+) -> BaseMessageIntel:
+    bot = Bot()
+    return bot.llm.prompt_to_intel(
+        prompt=user_input,
+        intel_class=DefaultMessageIntel,
+        message_history=message_history,
+    )
+
+
+@recorder_to_html_file('spire_ai_chat_workflow')
+def chat_workflow(
+    request: WSGIRequest,
+    user_input: str,
+    message_history: MessageHistory | None = None
+) -> BaseMessageIntel:
+    intent_decoder = generate_intent_decoder(
+        request=request,
+        default_callable=default_chat_response,
+    )
+
+    intent_process = intent_decoder.process(user_input, max_return_values=1)[0]
+
+    @log_ai_interaction_from_recorder(request.user)
+    def run_workflow_process(callable_: Callable) -> BaseMessageIntel | None:
+        return callable_(
+            request=request,
+            user_input=user_input,
+            message_history=message_history,
+        )
+
+    message_intel = run_workflow_process(intent_process)
+
+    if not isinstance(message_intel, BaseMessageIntel):
+        message = f'{intent_process.__qualname__} must return an instance of a {BaseMessageIntel.__name__} sub class.'
+        raise TypeError(message)
+
+    return message_intel

django_spire-0.19.1/django_spire/ai/chat/models.py

@@ -0,0 +1,153 @@
+from __future__ import annotations
+
+from dandy.llm.request.message import MessageHistory, RoleLiteralStr
+from django.contrib.auth.models import User
+from django.db import models
+from django.utils.timezone import now
+
+from django_spire.ai.chat.message_intel import BaseMessageIntel, DefaultMessageIntel
+from django_spire.ai.chat.responses import MessageResponse
+from django_spire.ai.chat.choices import MessageResponseType
+from django_spire.ai.chat.querysets import ChatQuerySet, ChatMessageQuerySet
+from django_spire.history.mixins import HistoryModelMixin
+from django_spire.utils import get_class_from_string, get_class_name_from_class
+
+
+class Chat(HistoryModelMixin):
+    user = models.ForeignKey(
+        User,
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL,
+        related_name='chats',
+        related_query_name='chat'
+    )
+
+    name = models.CharField(max_length=128)
+    last_message_datetime = models.DateTimeField(default=now, editable=False)
+    has_unread_messages = models.BooleanField(default=False)
+
+    objects = ChatQuerySet.as_manager()
+
+    def __str__(self):
+        if len(self.name) < 48:
+            return self.name
+
+        return self.name[:48] + '...'
+
+    def add_message_response(self, message_response: MessageResponse) -> None:
+        self.messages.create(
+            response_type=message_response.type.value,
+            sender=message_response.sender,
+            _intel_data=message_response.message_intel.model_dump(),
+            _intel_class_name=get_class_name_from_class(message_response.message_intel.__class__),
+            is_processed=True,
+            is_viewed=True
+        )
+        self.last_message_datetime = now()
+        self.save()
+
+    def generate_message_history(
+            self,
+            message_count: int = 20,
+            exclude_last_message: bool = True
+    ) -> MessageHistory:
+        message_history = MessageHistory()
+
+        messages = self.messages.newest_by_count(message_count)
+
+        if exclude_last_message:
+            messages = messages[1:]
+
+        messages = list(reversed(messages))
+
+        for message in messages:
+            message_history.add_message(
+                role=message.role,
+                content=message.intel.content_to_str()
+            )
+
+        return message_history
+
+    @property
+    def is_empty(self) -> bool:
+        return self.messages.count() == 0
+
+    @property
+    def name_shortened(self) -> str:
+        if len(self.name) > 24:
+            return self.name[:24] + '...'
+
+        return self.name
+
+    class Meta:
+        db_table = 'django_spire_ai_chat'
+        verbose_name = 'Chat'
+        verbose_name_plural = 'Chats'
+        ordering = ('-last_message_datetime', 'name')
+
+
+class ChatMessage(HistoryModelMixin):
+    chat = models.ForeignKey(
+        Chat,
+        on_delete=models.CASCADE,
+        related_name='messages',
+        related_query_name='message'
+    )
+
+    response_type = models.CharField(max_length=32, choices=MessageResponseType)
+    sender = models.CharField(max_length=128)
+    _intel_data = models.JSONField()
+    _intel_class_name = models.TextField()
+    is_processed = models.BooleanField(default=False)
+    is_viewed = models.BooleanField(default=False)
+
+    objects = ChatMessageQuerySet.as_manager()
+
+    def __str__(self):
+        content = self.intel.content_to_str()
+
+        if len(content) < 64:
+            return content
+
+        return content[:64] + '...'
+
+    @property
+    def intel(self):
+        try:
+            intel_class: type[BaseMessageIntel] = get_class_from_string(self._intel_class_name)
+            return intel_class.model_validate(self._intel_data)
+
+        except ImportError:
+            intel_class: type[BaseMessageIntel] = DefaultMessageIntel
+            return intel_class.model_validate(
+                {'text': str(self._intel_data)}
+            )
+
+    @intel.setter
+    def intel(self, message_intel: BaseMessageIntel):
+        self._intel_class_name = get_class_name_from_class(message_intel.__class__)
+        self._intel_data = message_intel.model_dump()
+
+    @property
+    def role(self) -> RoleLiteralStr:
+        if self.response_type == 'request':
+            return 'user'
+
+        if self.response_type == 'response':
+            return 'assistant'
+
+        return 'system'
+
+    def to_message_response(self) -> MessageResponse:
+        return MessageResponse(
+            type=MessageResponseType(self.response_type),
+            sender=self.sender,
+            message_intel=self.intel,
+            message_timestamp=self.created_datetime.strftime('%b %d, %Y at %I:%M %p')
+        )
+
+    class Meta:
+        db_table = 'django_spire_ai_chat_message'
+        verbose_name = 'Chat Message'
+        verbose_name_plural = 'Chat Messages'

django_spire-0.19.1/django_spire/ai/chat/querysets.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from django.db.models import Q, Count
+
+from django_spire.history.querysets import HistoryQuerySet
+
+
+class ChatQuerySet(HistoryQuerySet):
+    def by_user(self, user):
+        return self.filter(user=user)
+
+    def get_empty_or_create(self, user):
+        try:
+            return (
+                self.filter(user=user)
+                .annotate(num_messages=Count('message'))
+                .filter(num_messages=0)
+                .earliest('-id')
+            )
+        except self.model.DoesNotExist:
+            return self.create(user=user)
+
+    def search(self, query: str):
+        return self.filter(
+            Q(name__icontains=query)
+        )
+
+
+class ChatMessageQuerySet(HistoryQuerySet):
+    def newest_by_count(self, count: int = 20):
+        return self.order_by('-created_datetime')[:count]
+
+    def newest_by_count_reversed(self, count: int = 20):
+        return self.order_by('-created_datetime')[:count][::-1]

django_spire-0.19.1/django_spire/ai/chat/responses.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+from django.template.loader import render_to_string
+
+from django_spire.ai.chat.choices import MessageResponseType
+
+if TYPE_CHECKING:
+    from typing import Any
+
+    from django_spire.ai.chat.message_intel import BaseMessageIntel
+
+
+@dataclass
+class MessageResponse:
+    type: MessageResponseType
+    sender: str
+    message_intel: BaseMessageIntel
+    message_timestamp: str | None = None
+    synthesis_speech: bool = False
+
+    def _render_template_to_html_string(self, template: str, context_data: dict[str, Any] | None = None) -> str:
+        return render_to_string(
+            template_name=template,
+            context={
+                'message_timestamp': self.message_timestamp,
+                'sender': self.sender,
+                'message_intel': self.message_intel,
+                'synthesis_speech': self.synthesis_speech,
+                **(context_data or {})
+            },
+        )
+
+    def render_to_html_string(self, context_data: dict[str, Any] | None = None) -> str:
+        if self.type == MessageResponseType.REQUEST:
+            return self._render_template_to_html_string(
+                'django_spire/ai/chat/message/request_message.html',
+                context_data
+            )
+
+        if self.type == MessageResponseType.RESPONSE:
+            return self._render_template_to_html_string(
+                'django_spire/ai/chat/message/response_message.html',
+                context_data
+            )
+
+        if self.type == MessageResponseType.LOADING_RESPONSE:
+            return self._render_template_to_html_string(
+                'django_spire/ai/chat/message/loading_response_message.html',
+                context_data
+            )
+
+        return ''
+
+
+@dataclass
+class MessageResponseGroup:
+    message_responses: list[MessageResponse] = field(default_factory=list)
+
+    def add_message_response(self, message_response: MessageResponse) -> None:
+        self.message_responses.append(message_response)
+
+    def render_to_html_string(self, context_data: dict[str, Any] | None = None) -> str:
+        html_string = ''
+
+        context_data = context_data or {}
+        context_data['is_loading'] = context_data.get('is_loading', False)
+
+        for message_response in self.message_responses:
+            html_string += message_response.render_to_html_string(context_data)
+
+        return html_string

django_spire-0.19.1/django_spire/ai/chat/templates/django_spire/ai/chat/card/chat_card.html

@@ -0,0 +1,13 @@
+{% extends 'django_spire/card/card.html' %}
+
+{% block card_padding %}
+	px-3 py-2
+{% endblock %}
+
+{% block card_content %}
+    <div class="row">
+        <div class="col-12 vh-minus-top-nav">
+            {% include 'django_spire/ai/chat/widget/selection_widget.html' %}
+        </div>
+    </div>
+{% endblock %}