django-spire 0.0.6a0__tar.gz → 0.19.0__tar.gz

django_spire-0.19.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: django-spire
+Version: 0.19.0
+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.0/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.0/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.0/django_spire/ai/apps.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class AiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'django_spire_ai'
+    name = 'django_spire.ai'
+
+    REQUIRED_APPS = ('django_spire_core',)
+    URLPATTERNS_INCLUDE = 'django_spire.ai.urls'
+    URLPATTERNS_NAMESPACE = 'ai'
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire-0.19.0/django_spire/ai/chat/admin.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+from typing import ClassVar
+
+from django.contrib import admin
+from django.shortcuts import reverse
+from django.utils.html import format_html
+from django.utils.http import urlencode
+
+from django_spire.ai.chat import models
+
+
+@admin.register(models.Chat)
+class ChatAdmin(admin.ModelAdmin):
+    list_display = ('name', 'user', 'view_chat_messages_link', 'created_datetime')
+    search_fields = ('id', 'name')
+    ordering: ClassVar = ['-id']
+
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
+        return [field.name for field in self.model._meta.fields]
+
+    def view_chat_messages_link(self, obj):
+        count = obj.messages.count()
+        url = (
+            reverse("admin:django_spire_ai_chat_chatmessage_changelist")
+            + "?"
+            + urlencode({"chat__id": f"{obj.id}"})
+        )
+
+        return format_html(f'<a href="{url}">{count} Messages</a>')
+
+    view_chat_messages_link.short_description = "Messages"
+
+    class Meta:
+        ordering = ('id', )
+
+
+@admin.register(models.ChatMessage)
+class ChatMessageAdmin(admin.ModelAdmin):
+    list_display = ('content_body', 'chat', 'chat__user','is_processed', 'is_viewed', 'created_datetime')
+    search_fields = ('id', 'content')
+    ordering: ClassVar = ['-id']
+
+    def content_body(self, obj) -> str:
+        return str(obj)
+
+    content_body.short_description = 'Body'
+
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
+        return [field.name for field in self.model._meta.fields]
+

django_spire-0.19.0/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.0/django_spire/ai/chat/auth/controller.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from django_spire.auth.controller.controller import BaseAuthController
+
+
+class BaseAiChatAuthController(BaseAuthController):
+    def can_delete(self) -> bool:
+        return self.request.user.has_perm('django_spire_ai_chat.delete_chat')

django_spire-0.19.0/django_spire/ai/chat/choices.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from django.db.models import Choices
+
+
+class MessageResponseType(Choices):
+    REQUEST = 'request'
+    RESPONSE = 'response'
+    LOADING_RESPONSE = 'loading_response'

django_spire-0.19.0/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.0/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.0/django_spire/ai/chat/intelligence/workflows/chat_workflow.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Callable
+
+from dandy.recorder import recorder_to_html_file
+
+from django_spire.ai.chat.intelligence.decoders.tools import generate_intent_decoder
+from django_spire.ai.decorators import log_ai_interaction_from_recorder
+from django_spire.conf import settings
+from django_spire.core.utils import (
+    get_callable_from_module_string_and_validate_arguments,
+)
+from django_spire.ai.chat.message_intel import BaseMessageIntel
+
+if TYPE_CHECKING:
+    from dandy.llm.request.message import MessageHistory
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+@recorder_to_html_file('spire_ai_chat_workflow')
+def chat_workflow(
+    request: WSGIRequest,
+    user_input: str,
+    message_history: MessageHistory | None = None
+) -> BaseMessageIntel:
+    if settings.AI_CHAT_DEFAULT_CALLABLE is not None:
+        default_process = get_callable_from_module_string_and_validate_arguments(
+                module_string=settings.AI_CHAT_DEFAULT_CALLABLE,
+                valid_args=('request', 'user_input', 'message_history'),
+            )
+    else:
+        default_process = None
+
+    intent_decoder = generate_intent_decoder(
+        request=request,
+        default_callable=default_process,
+    )
+
+    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 message_intel is None and default_process is not None:
+        message_intel = run_workflow_process(default_process)
+
+    if not issubclass(message_intel.__class__, 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.0/django_spire/ai/chat/message_intel.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from abc import abstractmethod, ABC
+
+from dandy import BaseIntel
+from django.template.loader import render_to_string
+
+
+class BaseMessageIntel(BaseIntel, ABC):
+    _template: str
+
+    def __init_subclass__(cls):
+        super().__init_subclass__()
+
+        if cls._template is None or cls._template == '':
+            message = f'{cls.__module__}.{cls.__qualname__}._template must be set'
+            raise ValueError(message)
+
+    @abstractmethod
+    def content_to_str(self) -> str:
+        raise NotImplementedError
+
+    def render_to_string(self, context_data: dict | None = None):
+        return render_to_string(
+            template_name=self._template,
+            context={**self.model_dump(), **(context_data or {})},
+        )
+
+    @property
+    def template(self) -> str:
+        return self._template
+
+
+class DefaultMessageIntel(BaseMessageIntel):
+    _template: str = 'django_spire/ai/chat/message/default_message.html'
+    text: str
+
+    def content_to_str(self) -> str:
+        return self.text

django_spire-0.19.0/django_spire/ai/chat/migrations/0001_initial.py

@@ -0,0 +1,55 @@
+# Generated by Django 5.2 on 2025-04-23 17:23
+
+import django.db.models.deletion
+import django.utils.timezone
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Chat',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('name', models.CharField(max_length=128)),
+                ('last_message_datetime', models.DateTimeField(default=django.utils.timezone.now, editable=False)),
+                ('has_unread_messages', models.BooleanField(default=False)),
+                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='chats', related_query_name='chat', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Chat',
+                'verbose_name_plural': 'Chats',
+                'db_table': 'django_spire_ai_chat',
+                'ordering': ('-last_message_datetime', 'name'),
+            },
+        ),
+        migrations.CreateModel(
+            name='ChatMessage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('content', models.JSONField()),
+                ('is_processed', models.BooleanField(default=False)),
+                ('is_viewed', models.BooleanField(default=False)),
+                ('chat', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='messages', related_query_name='message', to='django_spire_ai_chat.chat')),
+            ],
+            options={
+                'verbose_name': 'Chat Message',
+                'verbose_name_plural': 'Chat Messages',
+                'db_table': 'django_spire_ai_chat_message',
+            },
+        ),
+    ]

django_spire-0.19.0/django_spire/ai/chat/migrations/0002_remove_chatmessage_content_chatmessage__content_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.2 on 2025-05-06 21:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='chatmessage',
+            name='content',
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_content',
+            field=models.JSONField(default=''),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_content_intel_class',
+            field=models.CharField(default=' ', max_length=64),
+            preserve_default=False,
+        ),
+    ]

django_spire-0.19.0/django_spire/ai/chat/migrations/0003_rename__content_chatmessage__intel_data_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2 on 2025-05-17 23:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0002_remove_chatmessage_content_chatmessage__content_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='chatmessage',
+            old_name='_content',
+            new_name='_intel_data',
+        ),
+        migrations.RemoveField(
+            model_name='chatmessage',
+            name='_content_intel_class',
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_intel_class_name',
+            field=models.TextField(default=''),
+            preserve_default=False,
+        ),
+    ]

django_spire-0.19.0/django_spire/ai/chat/migrations/0004_chatmessage_response_type_chatmessage_sender.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.2 on 2025-05-17 23:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0003_rename__content_chatmessage__intel_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='chatmessage',
+            name='response_type',
+            field=models.CharField(choices=[('request', 'Request'), ('response', 'Response'), ('loading_response', 'Loading Response')], default='request', max_length=32),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='sender',
+            field=models.CharField(default='', max_length=128),
+            preserve_default=False,
+        ),
+    ]