django-spire 0.15.11__tar.gz → 0.16.1__tar.gz

{django_spire-0.15.11 → django_spire-0.16.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.15.11
+Version: 0.16.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.
@@ -67,6 +67,7 @@ Requires-Dist: build; extra == "development"
 Requires-Dist: django-debug-toolbar; extra == "development"
 Requires-Dist: pip; extra == "development"
 Requires-Dist: pyinstrument; extra == "development"
+Requires-Dist: pytest; extra == "development"
 Requires-Dist: setuptools; extra == "development"
 Requires-Dist: twine; extra == "development"
 Provides-Extra: documentation

django_spire-0.16.1/django_spire/ai/chat/intelligence/maps/intent_llm_map.py

@@ -0,0 +1,7 @@
+from dandy.llm import BaseLlmMap
+from dandy.map import Map
+
+
+class IntentLlmMap(BaseLlmMap):
+    map_keys_description = 'The user\'s chat intent'
+    map = Map({})

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

@@ -0,0 +1,17 @@
+from dandy.llm import Prompt
+
+from django_spire.conf import settings
+
+
+def organization_prompt():
+    return (
+        Prompt()
+        .text(f'You are a chat assistant for a company called "{settings.ORGANIZATION_NAME}".')
+        .line_break()
+        .text(f'Organization Description: "{settings.ORGANIZATION_DESCRIPTION}"')
+        .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.16.1/django_spire/ai/chat/intelligence/workflows/chat_workflow.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Type
+
+from dandy.map import Map
+from dandy.recorder import recorder_to_html_file
+from dandy.workflow import BaseWorkflow
+from dandy.llm import LlmBot, MessageHistory, Prompt
+from django.core.handlers.wsgi import WSGIRequest
+
+from django_spire.ai.chat.intelligence.maps.intent_llm_map import IntentLlmMap
+from django_spire.ai.chat.intelligence.prompts import organization_prompt
+from django_spire.ai.chat.message_intel import DefaultMessageIntel
+from django_spire.auth.controller.controller import AppAuthController
+from django_spire.knowledge.intelligence.workflows.knowledge_workflow import \
+    KnowledgeWorkflow
+
+
+if TYPE_CHECKING:
+    from django_spire.ai.chat.message_intel import BaseMessageIntel
+
+
+class SpireChatWorkflow(BaseWorkflow):
+    @classmethod
+    def _generate_intent_map(cls, request: WSGIRequest) -> Type[IntentLlmMap]:
+        intent_dict = {}
+
+        if AppAuthController(app_name='knowledge', request=request).can_view():
+            intent_message = (
+                'The user is looking for information or knowledge on something.'
+            )
+            intent_dict[intent_message] = KnowledgeWorkflow
+
+        intent_dict['None of the above choices match the user\'s intent'] = None
+
+        IntentLlmMap.map = Map(intent_dict)
+        IntentLlmMap._map_enum = IntentLlmMap.map.as_enum()
+        return IntentLlmMap
+
+    @classmethod
+    @recorder_to_html_file('spire_chat_workflow')
+    def process(
+            cls,
+            request: WSGIRequest,
+            user_input: str,
+            message_history: MessageHistory | None = None
+    ) -> BaseMessageIntel:
+        intent_map = cls._generate_intent_map(request)
+        intents = intent_map.process(user_input, max_return_values=1)
+
+        if intents[0] is None:
+            response = LlmBot.process(
+                prompt=user_input,
+                message_history=message_history,
+                postfix_system_prompt=organization_prompt()
+            )
+
+            return DefaultMessageIntel(text=response.text)
+
+        response = LlmBot.process(
+            prompt=(
+                Prompt()
+                .text(f'User Input: {user_input}')
+                .line_break()
+                .text(
+                    'Use the following information to the answer the user\'s question '
+                    'or concern.'
+                )
+                .line_break()
+                .text(intents[0].process(user_input))
+            ),
+            message_history=message_history,
+            postfix_system_prompt=organization_prompt()
+        )
+
+        return DefaultMessageIntel(text=response.text)

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/ai/chat/templates/django_spire/ai/chat/message/loading_response_message.html

@@ -14,7 +14,7 @@
         response_message: new ViewGlue(
             '{% url "django_spire:ai:chat:message:response:new" %}',
             {
-                message_body: '{{ message_intel.text }}',
+                message_body: JSON.parse(document.getElementById('message_intel_text').textContent),
                 chat_id: '{{ chat_id }}',
                 synthesis_speech: '{{ synthesis_speech }}' === 'True'
             }
@@ -23,6 +23,7 @@
     x-show="show_loading"
     x-cloak
 >
+    {{ message_intel.text|json_script:'message_intel_text' }}
     <div x-ref="loading_response_message" class="row mt-2 pb-3">
         <div class="col-auto align-self-center">
             <div class="row align-items-center">

django_spire-0.16.1/django_spire/ai/chat/templates/django_spire/ai/chat/message/message.html

@@ -0,0 +1,52 @@
+{% load spire_core_tags %}
+
+{% block message %}
+    {% generate_id as message_intel_id %}
+    <div
+        class="col-auto mb-1 {{ message_class }}"
+        @mouseover="show_message_menu = true"
+        @mouseleave="show_message_menu = false"
+        x-data="{
+            show_message_menu: false,
+            message_intel_str: '',
+            init() {
+                this.message_intel_str = JSON.parse(document.getElementById('{{ message_intel_id }}').textContent)
+                {% if synthesis_speech %}this.start_speaking(this.message_intel_str){% endif %}
+                $el.scrollIntoView({behavior: 'smooth'})
+            }
+        }"
+    >
+        <div class="container-fluid">
+            {{ message_intel.content_to_str|json_script:message_intel_id }}
+            <div class="row">
+                <div class="col fs--1 {{ sender_class }}">
+                    {% block message_sender %}
+                        {{ sender }}
+                    {% endblock %}
+                </div>
+            </div>
+            <div class="row">
+                <div class="col-12 px-3 py-2 rounded-3 shadow-sm {{ content_class|default:'border' }}">
+                    {% block message_content %}
+                        {{ message_intel.content_to_str|linebreaksbr }}
+                    {% endblock %}
+                </div>
+            </div>
+            <div
+                class="row justify-content-end"
+                :class="show_message_menu ? 'opacity-100' : 'opacity-0'"
+            >
+                <div class="col-auto px-0">
+                    <div @click="start_speaking(message_intel_str)" class="py-1 px-2 cursor-pointer">
+                        <i class="bi bi-soundwave"></i>
+                    </div>
+                </div>
+                <div class="col-auto pe-0 ps-1">
+                    <div @click="send_chat({message_body: message_intel_str})" class="py-1 px-2 cursor-pointer">
+                        <i class="bi bi-repeat"></i>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/ai/chat/templates/django_spire/ai/chat/widget/dialog_widget.html

@@ -1,36 +1,40 @@
 {% extends 'django_spire/speech/speech_recognition.html' %}
 
 {% block speech_recognition_content %}
+    <div
+        class="row"
+        x-data="{
+            request_message_view: new ViewGlue('{% url "django_spire:ai:chat:message:request:new" %}'),
+            load_messages_view: new ViewGlue('{% url "django_spire:ai:chat:message:load_chat" chat_id=chat.id %}'),
+            chat_id: '{{ chat.id }}',
+            message_body: '',
 
-    <div x-data="{
-        request_message_view: new ViewGlue('{% url "django_spire:ai:chat:message:request:new" %}'),
-        load_messages_view: new ViewGlue('{% url "django_spire:ai:chat:message:load_chat" chat_id=chat.id %}'),
-        chat_id: '{{ chat.id }}',
-        message_body: '',
-        async send_chat(synthesis_speech_for_response = false, message_body = '') {
-            if(this.message_body !== '') {
-                await this.request_message_view.render_insert_adjacent(this.$refs.target_div, {
-                        message_body: this.message_body.trim(),
-                        chat_id: this.chat_id,
-                        synthesis_speech: synthesis_speech_for_response
-                    })
-                this.message_body = ''
-            }
-        },
-        load_messages() {
-            this.load_messages_view.render_insert_adjacent(this.$refs.target_div, {})
-        },
-        init() {
-            setTimeout(() => this.$refs.target_div.scrollTop = this.$refs.target_div.scrollHeight, 1500)
-
+            init() {
+                setTimeout(() => this.$refs.target_div.scrollTop = this.$refs.target_div.scrollHeight, 1500)
 
-            this.speech_recognition.onresult = () => {
-                this.message_body = this.speech_transcript
-                this.send_chat(true)
+                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() {
+                this.load_messages_view.render_insert_adjacent(this.$refs.target_div, {})
+            },
+            async send_chat({message_body = '', synthesis_speech_for_response = false}) {
+                if (message_body !== '') {
+                    await this.request_message_view.render_insert_adjacent(
+                        this.$refs.target_div,
+                        {
+                            message_body: message_body,
+                            chat_id: this.chat_id,
+                            synthesis_speech: synthesis_speech_for_response
+                        }
+                    )
+                    this.message_body = ''
+                }
             }
-
-        }
-    }" class="row">
+        }"
+    >
         <div class="col-12">
             <div class="row px-0 border-bottom">
                 <div class="col-auto ps-2 pe-0 h-100 d-block d-md-none text-app-primary"
@@ -45,7 +49,6 @@
             <div class="row mb-3">
                 <div x-init="load_messages()" x-ref="target_div" class="col-12 overflow-auto p-4"
                      style="height: calc(100vh - 90px - var(--app-top-navigation-height));">
-
                 </div>
             </div>
 
@@ -59,11 +62,11 @@
                     </button>
                 </div>
                 <div class="col text-center px-1">
-                    <input type="text" x-init="$el.focus()" x-model="message_body" @keyup.enter="send_chat()"
+                    <input type="text" x-init="$el.focus()" x-model="message_body" @keyup.enter="send_chat({message_body: message_body})"
                            class="form-control" autocomplete="off" name="request_message">
                 </div>
                 <div class="col-auto text-center ps-1 pe-2">
-                    <button class="btn btn-app-primary-outlined" @click="send_chat()">
+                    <button class="btn btn-app-primary-outlined" @click="send_chat({message_body: message_body})">
                         <i class="bi bi-send"></i>
                     </button>
                 </div>

django_spire-0.16.1/django_spire/ai/sms/intelligence/workflows/sms_conversation_workflow.py

@@ -0,0 +1,27 @@
+from dandy.recorder import recorder_to_html_file
+from dandy.workflow import BaseWorkflow
+from dandy.llm import MessageHistory
+from django.core.handlers.wsgi import WSGIRequest
+
+from django_spire.ai.chat.intelligence.workflows.chat_workflow import SpireChatWorkflow
+from django_spire.ai.sms.intel import SmsIntel
+
+
+class SmsConversationWorkflow(BaseWorkflow):
+    @classmethod
+    @recorder_to_html_file('sms_workflow')
+    def process(
+            cls,
+            request: WSGIRequest,
+            user_input: str,
+            message_history: MessageHistory | None = None
+    ) -> SmsIntel:
+        return SmsIntel(
+            body=str(
+                SpireChatWorkflow.process(
+                    request,
+                    user_input=user_input,
+                    message_history=message_history,
+                )
+            )
+        )

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/auth/seeding/seed.py

@@ -1,3 +1,3 @@
 from django_spire.auth.seeding.seeder import UserSeeder
 
-UserSeeder.seed_database(count=20)
+UserSeeder.seed_database(count=20)

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/conf.py

@@ -2,8 +2,9 @@ from django.conf import settings as django_settings
 
 from django_spire import settings as django_spire_default_settings
 
+
 class Settings:
-    def __getattr__(self, name):
+    def __getattr__(self, name: str):
         django_value = None
         django_spire_value = None
 
@@ -26,7 +27,8 @@ class Settings:
         if django_spire_value is not None:
             return django_spire_value
 
-        raise f'No attribute {name} found in settings.'
+        message = f'No attribute {name} found in settings.'
+        raise AttributeError(message)
 
 
 settings = Settings()

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.15.11'
+__VERSION__ = '0.16.1'
 
 
 AI_CHAT_WORKFLOW_SENDER_SETTINGS_NAME = 'AI_CHAT_WORKFLOW_NAME'

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/contrib/seeding/field/base.py

@@ -22,7 +22,8 @@ class BaseFieldSeeder(ABC):
         super().__init_subclass__(**kwargs)
 
         if cls.keyword is None:
-            raise ValueError("Seeds must have a keyword")
+            message = 'Seeds must have a keyword'
+            raise ValueError(message)
 
     def _normalize_fields(self, fields: dict) -> dict:
         return normalize_seeder_fields(fields)

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/contrib/seeding/field/cleaners.py

@@ -4,15 +4,18 @@ import copy
 
 def normalize_seeder_fields(fields: dict) -> dict:
     normalized = {}
+
     for k, v in fields.items():
-        if v == "exclude" or v == ("exclude",):
+        if v in ("exclude", ("exclude",)):
             continue
 
         if isinstance(v, tuple):
             # Safely clone v[2] if it's a dict
             extra = ()
+
             if len(v) > 2:
                 extra_value = v[2]
+
                 if isinstance(extra_value, dict):
                     extra = (copy.deepcopy(extra_value),)
                 else:

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/contrib/seeding/field/custom.py

@@ -9,14 +9,18 @@ class CustomFieldSeeder(BaseFieldSeeder):
     keyword = FieldSeederTypesEnum.CUSTOM
 
     def in_order(self, values: list, index: int) -> any:
-        index = index % len(values) # Index loops back on itself
+        if not values:
+            raise ValueError(
+                "Cannot select from empty values list. "
+                "Make sure the related model has existing records before seeding foreign keys."
+            )
+        index = index % len(values)  # Index loops back on itself
         return values[index]
 
     def date_time_between(self, start_date: str, end_date: str):
         faker = Faker()
         naive_dt = faker.date_time_between(start_date=start_date, end_date=end_date)
-        aware_dt = timezone.make_aware(naive_dt)
-        return aware_dt
+        return timezone.make_aware(naive_dt)
 
     def fk_random(self, model_class, ids: list[int]):
         faker = Faker()
@@ -35,13 +39,13 @@ class CustomFieldSeeder(BaseFieldSeeder):
             row = {}
 
             for field_name, config in self.seeder_fields.items():
-
                 method_name = config[1] if len(config) > 1 else field_name
                 kwargs = config[2] if len(config) > 2 else {}
                 method = getattr(self, method_name, None)
 
                 if not callable(method):
-                    raise ValueError(f"Custom method '{method_name}' not found for field '{field_name}'")
+                    message = f"Custom method '{method_name}' not found for field '{field_name}'"
+                    raise TypeError(message)
 
                 if method_name in ['in_order', 'fk_in_order']:
                     kwargs["index"] = i
@@ -49,12 +53,13 @@ class CustomFieldSeeder(BaseFieldSeeder):
                 if method_name in ['fk_random', 'fk_in_order']:
                     model_class = kwargs["model_class"]
 
-                    if model_class not in foreign_keys.keys():
-                        foreign_keys[model_class] = model_class.objects.all().values_list('id', flat=True)
+                    if model_class not in foreign_keys:
+                        foreign_keys[model_class] = list(model_class.objects.all().values_list('id', flat=True))
 
                     kwargs['ids'] = foreign_keys[model_class]
 
                 row[field_name] = method(**kwargs)
 
             data.append(row)
+
         return data

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/contrib/seeding/field/django/seeder.py

@@ -92,7 +92,7 @@ class DjangoFieldLlmSeeder(BaseFieldSeeder):
 
     @property
     def field_prompt(self) -> Prompt:
-        # Todo: Add functionality here to take a prompt.
+        # TODO: Add functionality here to take a prompt.
         if any(len(info) > 1 for info in self.seeder_fields.values()):
             field_prompt = (
                 Prompt()
@@ -115,10 +115,13 @@ class DjangoFieldFakerSeeder(BaseFieldSeeder):
 
     def seed(self, model_seeder, count = 1) -> list[dict]:
         data = []
-        for i in range(count):
+
+        for _ in range(count):
             row = {}
+
             for field_name, faker_config in self.seeder_fields.items():
                 faker_method = faker_config[1:] if len(faker_config) > 1 else None
+
                 try:
                     row[field_name] = fake_model_field_value(
                         model_class=model_seeder.model_class,
@@ -126,6 +129,9 @@ class DjangoFieldFakerSeeder(BaseFieldSeeder):
                         faker_method=faker_method
                     )
                 except Exception as e:
-                    raise ValueError(f"Error generating faker value for field '{field_name}': {e}")
+                    message = f"Error generating faker value for field '{field_name}': {e}"
+                    raise ValueError(message) from None
+
             data.append(row)
+
         return data

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/contrib/seeding/field/override.py

@@ -1,5 +1,3 @@
-
-
 class FieldOverride:
     def __init__(self, seeder_class):
         self.seeder_class = seeder_class
@@ -7,14 +5,14 @@ class FieldOverride:
 
     def __getattr__(self, name):
         """
-            Delegate attribute lookup to self.seeder_class if the attribute isn't found
-            in this FieldOverride instance.
+        Delegate attribute lookup to self.seeder_class if the attribute isn't found
+        in this FieldOverride instance.
         """
 
         attr = getattr(self.seeder_class, name)
         if callable(attr):
             def wrapper(*args, **kwargs):
-                # Todo: Error here if fields is passed as an arg.
+                # TODO: Error here if fields is passed as an arg.
                 # Pass the overrides field to the seed method
                 if 'fields' in kwargs and isinstance(kwargs['fields'], dict):
                     kwargs['fields'] = {**kwargs['fields'], **self.overrides}

django_spire-0.16.1/django_spire/core/context_processors.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from typing_extensions import Any, TYPE_CHECKING
+
+from django_spire.auth.controller.controller import AppAuthController
+from django_spire.conf import settings
+from django_spire.consts import __VERSION__
+from django_spire.theme.models import Theme
+from django_spire.theme.utils import get_theme_cookie_name
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def django_spire(request: WSGIRequest) -> dict[str, Any]:
+    auth_controller_dict = {}
+
+    for app_name in settings.DJANGO_SPIRE_AUTH_CONTROLLERS:
+        auth_controller_dict[app_name] = AppAuthController(app_name, request=request)
+
+    return {
+        'DJANGO_SPIRE_VERSION': __VERSION__,
+        'app_bootstrap_icon': {
+            'help_desk': 'bi bi-headset'
+        },
+        'AuthController': auth_controller_dict
+    }
+
+
+def theme_context(request: WSGIRequest) -> dict[str, Any]:
+    default_string = getattr(
+        settings,
+        'DJANGO_SPIRE_DEFAULT_THEME',
+        'default-light'
+    )
+
+    default = Theme.from_string(
+        default_string,
+        default=Theme.get_default()
+    )
+
+    name = get_theme_cookie_name()
+    cookie = request.COOKIES.get(name, '')
+    theme = Theme.from_string(cookie, default=default)
+
+    path = getattr(
+        settings,
+        'DJANGO_SPIRE_THEME_PATH',
+        '/static/django_spire/css/themes/{family}/app-{mode}.css'
+    )
+
+    return {
+        'DJANGO_SPIRE_DEFAULT_THEME': default.value,
+        'DJANGO_SPIRE_THEME_COOKIE_NAME': name,
+        'DJANGO_SPIRE_THEME_PATH': path,
+        'theme': theme.to_dict(),
+    }

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/core/static/django_spire/css/app-import.css

@@ -1,4 +1,5 @@
 @import url('app-default.css');
+@import url('app-theme.css');
 @import url('app-background.css');
 @import url('app-border.css');
 @import url('app-button.css');
@@ -7,8 +8,3 @@
 @import url('app-page.css');
 @import url('app-text.css');
 @import url('app-template.css');
-
-/* The `app.css` and `app-override.css` file must be imported last */
-
-@import url('app.css');
-@import url('app-override.css');

django_spire-0.16.1/django_spire/core/static/django_spire/css/app-theme.css

@@ -0,0 +1,18 @@
+.theme-toggle {
+    background: var(--app-layer-one);
+    border: 1px solid var(--app-secondary-soft);
+    color: var(--app-default-text-color);
+    border-radius: 50%;
+    width: 40px;
+    height: 40px;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    cursor: pointer;
+    transition: all 0.3s ease;
+}
+
+.theme-toggle:hover {
+    transform: scale(1.1);
+    background: var(--app-layer-two);
+}

{django_spire-0.15.11 → django_spire-0.16.1}/django_spire/core/static/django_spire/css/bootstrap-extension.css

@@ -44,7 +44,7 @@ h1, h2, h3, h4, h5, h6 {
     left: 0;
     right: 0;
     transition: background-color 0.5s ease;
-    background: rgba(0, 0, 0, 0.5);
+    background: var(--app-overlay-light);
 }
 
 .fs--1 {
@@ -64,7 +64,7 @@ h1, h2, h3, h4, h5, h6 {
 }
 
 .modal-overlay {
-    background-color: rgba(0, 0, 0, 0.5);
+    background-color: var(--app-overlay-modal);
 }
 
 .ms-6 {
@@ -190,7 +190,7 @@ h1, h2, h3, h4, h5, h6 {
     right: 0;
     bottom: 0;
     left: 0;
-    background-color: rgba(0, 0, 0, 0.5);
+    background-color: var(--app-overlay-light);
     z-index: 1040;
     transition: opacity 0.3s ease-in-out;
 }