django-spire 0.19.4__py3-none-any.whl → 0.20.0__py3-none-any.whl

django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.19.4'
+__VERSION__ = '0.20.0'
 
 MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
 

django_spire/core/migrations/0001_initial.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.2.7 on 2025-11-09 05:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Tag',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.SlugField(max_length=128, unique=True)),
+            ],
+            options={
+                'verbose_name': 'Tag',
+                'verbose_name_plural': 'Tags',
+                'db_table': 'django_spire_core_tag',
+            },
+        ),
+    ]

django_spire/core/static/django_spire/css/app-background.css

@@ -33,6 +33,8 @@
     --app-bg-alt-layer-three: var(--app-alt-layer-three);
     --app-bg-alt-layer-four: var(--app-alt-layer-four);
 
+    --app-bg-card-header: var(--app-card-header);
+
     --app-bg-side-navigation: var(--app-side-navigation-bg-color);
 
     --app-bg-top-navigation: var(--app-top-navigation-bg-color);
@@ -151,6 +153,10 @@
     background-color: var(--app-bg-alt-layer-four) !important;
 }
 
+.bg-app-card-header {
+    background-color: var(--app-bg-card-header) !important;
+}
+
 .bg-app-side-navigation, .bg-app-side-navigation-hover:hover {
     background-color: var(--app-bg-side-navigation) !important;
 }

django_spire/core/static/django_spire/css/app-import.css

@@ -10,3 +10,4 @@
 @import url('app-side-panel.css');
 @import url('app-text.css');
 @import url('app-template.css');
+@import url('app-override.css');

django_spire/core/static/django_spire/css/themes/ayu/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #232834;
     --app-alt-layer-four: #343a46;
 
+    --app-card-header: #1f2430;
+
     --app-default-attribute-title-color: #bfbdb6;
     --app-default-button-text-color: #0f1419;
     --app-default-text-color: #bfbdb6;

django_spire/core/static/django_spire/css/themes/ayu/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #f7f8f9;
     --app-alt-layer-four: #eff1f3;
 
+    --app-card-header: #f0f0f0;
+
     --app-default-attribute-title-color: #828c99;
     --app-default-button-text-color: #fafafa;
     --app-default-text-color: #5c6773;

django_spire/core/static/django_spire/css/themes/catppuccin/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #393952;
     --app-alt-layer-four: #4a4b61;
 
+    --app-card-header: #313244;
+
     --app-default-attribute-title-color: #cdd6f4;
     --app-default-button-text-color: #1e1e2e;
     --app-default-text-color: #cdd6f4;

django_spire/core/static/django_spire/css/themes/catppuccin/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #a6adc8;
     --app-alt-layer-four: #9399b2;
 
+    --app-card-header: #dce0e8;
+
     --app-default-attribute-title-color: #6c6f85;
     --app-default-button-text-color: #eff1f5;
     --app-default-text-color: #4c4f69;

django_spire/core/static/django_spire/css/themes/default/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #292c2d;
     --app-alt-layer-four: #343738;
 
+    --app-card-header: #232526;
+
     --app-default-attribute-title-color: #ffffff;
     --app-default-button-text-color: #181818;
     --app-default-text-color: #ffffff;

django_spire/core/static/django_spire/css/themes/default/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #fcfcfc;
     --app-alt-layer-four: #f8f9fa;
 
+    --app-card-header: #f5f5f6;
+
     --app-default-attribute-title-color: #797c7d;
     --app-default-button-text-color: #ffffff;
     --app-default-text-color: #181818;

django_spire/core/static/django_spire/css/themes/gruvbox/app-dark.css

@@ -28,6 +28,8 @@
     --app-layer-three: #504945;
     --app-layer-four: #665c54;
 
+    --app-card-header: #3c3836;
+
     --app-alt-layer-one: #1d2021;
     --app-alt-layer-two: #32302f;
     --app-alt-layer-three: #45403d;

django_spire/core/static/django_spire/css/themes/gruvbox/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #e5d5b1;
     --app-alt-layer-four: #d0bfa5;
 
+    --app-card-header: #ebdbb2;
+
     --app-default-attribute-title-color: #665c54;
     --app-default-button-text-color: #fbf1c7;
     --app-default-text-color: #3c3836;

django_spire/core/static/django_spire/css/themes/material/app-dark.css

@@ -28,6 +28,8 @@
     --app-layer-three: #2d2d2d;
     --app-layer-four: #404040;
 
+    --app-card-header: #1e1e1e;
+
     --app-alt-layer-one: #0a0a0a;
     --app-alt-layer-two: #171717;
     --app-alt-layer-three: #262626;

django_spire/core/static/django_spire/css/themes/material/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #e8e8e8;
     --app-alt-layer-four: #d8d8d8;
 
+    --app-card-header: #f5f5f5;
+
     --app-default-attribute-title-color: #607d8b;
     --app-default-button-text-color: #ffffff;
     --app-default-text-color: #212121;

django_spire/core/static/django_spire/css/themes/nord/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #3e4758;
     --app-alt-layer-four: #475164;
 
+    --app-card-header: #3b4252;
+
     --app-default-attribute-title-color: #eceff4;
     --app-default-button-text-color: #2e3440;
     --app-default-text-color: #eceff4;

django_spire/core/static/django_spire/css/themes/nord/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #dfe5ef;
     --app-alt-layer-four: #c8d0df;
 
+    --app-card-header: #d8dee9;
+
     --app-default-attribute-title-color: #4c566a;
     --app-default-button-text-color: #eceff4;
     --app-default-text-color: #2e3440;

django_spire/core/static/django_spire/css/themes/one-dark/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #333841;
     --app-alt-layer-four: #424855;
 
+    --app-card-header: #2c313c;
+
     --app-default-attribute-title-color: #abb2bf;
     --app-default-button-text-color: #21252b;
     --app-default-text-color: #abb2bf;

django_spire/core/static/django_spire/css/themes/one-dark/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #eeeeef;
     --app-alt-layer-four: #e0e0e2;
 
+    --app-card-header: #e5e5e6;
+
     --app-default-attribute-title-color: #6c6f93;
     --app-default-button-text-color: #fafafa;
     --app-default-text-color: #383a42;

django_spire/core/static/django_spire/css/themes/palenight/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #3e4267;
     --app-alt-layer-four: #575c7c;
 
+    --app-card-header: #444267;
+
     --app-default-attribute-title-color: #a6accd;
     --app-default-button-text-color: #292d3e;
     --app-default-text-color: #a6accd;

django_spire/core/static/django_spire/css/themes/palenight/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #f8f9fc;
     --app-alt-layer-four: #f0f1f5;
 
+    --app-card-header: #e9eaef;
+
     --app-default-attribute-title-color: #8087a2;
     --app-default-button-text-color: #fafafa;
     --app-default-text-color: #4e5579;

django_spire/core/static/django_spire/css/themes/rose-pine/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #393748;
     --app-alt-layer-four: #524f67;
 
+    --app-card-header: #26233a;
+
     --app-default-attribute-title-color: #e0def4;
     --app-default-button-text-color: #191724;
     --app-default-text-color: #e0def4;

django_spire/core/static/django_spire/css/themes/rose-pine/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #e9dfd8;
     --app-alt-layer-four: #d6d2d5;
 
+    --app-card-header: #e6ddd6;
+
     --app-default-attribute-title-color: #797593;
     --app-default-button-text-color: #faf4ed;
     --app-default-text-color: #575279;

django_spire/core/static/django_spire/css/themes/tokyo-night/app-dark.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #292e42;
     --app-alt-layer-four: #3b4261;
 
+    --app-card-header: #24283b;
+
     --app-default-attribute-title-color: #c0caf5;
     --app-default-button-text-color: #1a1b26;
     --app-default-text-color: #c0caf5;

django_spire/core/static/django_spire/css/themes/tokyo-night/app-light.css

@@ -33,6 +33,8 @@
     --app-alt-layer-three: #f7f7f8;
     --app-alt-layer-four: #d6d6d8;
 
+    --app-card-header: #dfe0e5;
+
     --app-default-attribute-title-color: #6f7bb6;
     --app-default-button-text-color: #d5d6db;
     --app-default-text-color: #343b58;

django_spire/core/tags/intelligence/tag_set_bot.py

@@ -0,0 +1,41 @@
+from dandy import Bot, Prompt, BaseListIntel
+from django.utils.text import slugify
+
+
+class TagsIntel(BaseListIntel[list[str]]):
+    tags: list[str]
+
+
+class TagSetBot(Bot):
+    llm_role = 'Tag Identifier'
+    llm_task = 'Read through the provided content and return a list of tags.'
+    llm_guidelines = (
+        Prompt()
+        .list([
+            'Make sure to have enough tags to properly cover all the provided content.',
+            'Focus on tagging the words in the content',
+            'Only add additional words that are very relevant to the content.'
+            'Use spaces to separate words in tags',
+            'Include known acronyms along with the full tags.',
+        ])
+    )
+
+    def process(self, content: Prompt | str) -> set[str]:
+        tags_intel = self.llm.prompt_to_intel(
+            prompt=(
+                Prompt()
+                .heading('Content to be Tagged:')
+                .line_break()
+                .text(content)
+            ),
+            intel_class=TagsIntel
+        )
+
+        for tag in tags_intel:
+            word_segments = tag.split(" ")
+
+            if len(word_segments) > 1:
+                for word_segment in word_segments:
+                    tags_intel.append(word_segment)
+
+        return {slugify(tag) for tag in tags_intel}

django_spire/core/tags/mixins.py

@@ -0,0 +1,61 @@
+from django.db import models
+from django.db.models import QuerySet
+
+from django_spire.core.tags.models import Tag
+from django_spire.core.tags import tools
+
+
+class TagsModelMixin(models.Model):
+    tags = models.ManyToManyField(Tag, related_name='+', null=True, blank=True, editable=False)
+
+    class Meta:
+        abstract = True
+
+    @property
+    def tag_set(self) -> set[str]:
+        return set(self.tags.values_list('name', flat=True))
+
+    @property
+    def tag_set_simplified(self) -> set[str]:
+        simplified_tag_words = []
+
+        for tag in self.tag_set:
+            tag_words = tag.split('-')
+            simplified_tag_words.extend(tag_words)
+
+        return set(simplified_tag_words)
+
+    def add_tags_from_tag_set(self, tag_set: set[str]):
+        self._update_global_tags_from_set(tag_set)
+
+        self.tags.add(*Tag.objects.in_tag_set(tag_set))
+
+    def clear_tags(self):
+        self.tags.clear()
+
+    def get_matching_tags_from_tag_set(self, tag_set: set[str]) -> QuerySet:
+        return self.tags.in_tag_set(tag_set)
+
+    def get_matching_percentage_of_tag_set(self, tag_set: set[str]) -> float:
+        return tools.get_matching_a_percentage_from_tag_sets(tag_set, self.tag_set)
+
+    def get_matching_percentage_of_model_tags_from_tag_set(self, tag_set: set[str]) -> float:
+        return tools.get_matching_b_percentage_from_tag_sets(tag_set, self.tag_set)
+
+    def has_tags_in_tag_set(self, tag_set: set[str]) -> bool:
+        return self.tag_set.issuperset(tag_set)
+
+    def remove_tags_by_tag_set(self, tag_set: set[str]):
+        tag_objects = Tag.objects.in_tag_set(tag_set)
+
+        self.tags.remove(*tag_objects)
+
+    def set_tags_from_tag_set(self, tag_set: set[str]):
+        self._update_global_tags_from_set(tag_set)
+
+        tag_objects = Tag.objects.in_tag_set(tag_set)
+        self.tags.set(tag_objects)
+
+    @staticmethod
+    def _update_global_tags_from_set(tag_set: set[str]):
+        Tag.add_tags([Tag(name=tag) for tag in tag_set])

django_spire/core/tags/models.py

@@ -0,0 +1,38 @@
+from typing import Sequence, Self
+
+from django.db import models
+from django.utils.text import slugify
+
+from django_spire.core.tags.querysets import TagQuerySet
+
+
+class Tag(models.Model):
+    name = models.SlugField(
+        max_length=128,
+        unique=True
+    )
+
+    objects = TagQuerySet.as_manager()
+
+    def __init__(self, *args, **kwargs):
+        name = kwargs.get('name')
+        if name:
+            kwargs['name'] = slugify(name)
+
+        super().__init__(*args, **kwargs)
+
+    def __str__(self):
+        return self.name
+
+    @classmethod
+    def add_tags(cls, tags: Sequence[Self]):
+        cls.objects.bulk_create(
+            tags,
+            ignore_conflicts=True
+        )
+
+    class Meta:
+        db_table = 'django_spire_core_tag'
+        verbose_name = 'Tag'
+        verbose_name_plural = 'Tags'
+

django_spire/core/tags/querysets.py

@@ -0,0 +1,9 @@
+from django.db.models import QuerySet
+from django.utils.text import slugify
+
+
+class TagQuerySet(QuerySet):
+    def in_tag_set(self, tag_set: set[str]):
+        slugified_tag_set = set(map(slugify, tag_set))
+
+        return self.filter(name__in=slugified_tag_set)

django_spire/core/tags/tests/test_intelligence.py

@@ -0,0 +1,28 @@
+from unittest import TestCase
+
+from django_spire.core.tags.intelligence.tag_set_bot import TagSetBot
+
+TEST_INPUT = """
+    I love reading books about science fiction, fantasy, and adventure, especially ones
+    that feature artificial intelligence, machine learning, and natural language processing.
+    Some of my favorite authors include Isaac Asimov, J.R.R. Tolkien, and Neil Gaiman.
+    I'm also interested in learning more about data science, programming languages like Python
+    and Java, and emerging technologies like blockchain and the Internet of Things (IoT).
+    Can you recommend some books or resources that align with these interests?
+    """
+
+
+class TestTagIntelligence(TestCase):
+    def setUp(self):
+        pass
+
+    def test_tag_set_bot(self):
+        tag_set = TagSetBot().process(TEST_INPUT)
+
+        self.assertIn('science', tag_set)
+        self.assertIn('artificial', tag_set)
+        self.assertIn('fantasy', tag_set)
+
+        self.assertNotIn('camping', tag_set)
+        self.assertNotIn('art', tag_set)
+        self.assertNotIn('hate', tag_set)

django_spire/core/tags/tests/test_tags.py

@@ -0,0 +1,102 @@
+from django.test import TestCase
+
+from django_spire.core.tags.models import Tag
+from django_spire.knowledge.collection.models import Collection
+
+
+class TestTags(TestCase):
+    def setUp(self):
+        self.collection = Collection.objects.create(
+            name='Test Collection', description='Test Collection Description'
+        )
+
+        self.tag_set_a = {'apple', 'banana', 'orange'}
+        self.tag_set_b = {'grape', 'kiwi', 'pear'}
+        self.tag_set_c = {'lemon', 'lime', 'mango'}
+
+        self.mixed_tag_set = {'apple', 'grape', 'lemon'}
+
+        self.dirty_tag_set = {'HaT~', 'four* tacos', '123 hoop!!'}
+
+        self.collection.add_tags_from_tag_set(self.tag_set_a)
+        self.collection.add_tags_from_tag_set(self.tag_set_b)
+        self.collection.add_tags_from_tag_set(self.tag_set_c)
+
+        self.collection.add_tags_from_tag_set(self.mixed_tag_set)
+
+        self.collection.add_tags_from_tag_set(self.dirty_tag_set)
+
+    def test_tag_removal(self):
+        self.assertIn('apple', self.collection.tag_set)
+
+        self.collection.remove_tags_by_tag_set(self.mixed_tag_set)
+
+        self.assertNotIn('lemon', self.collection.tag_set)
+
+        self.assertIn('kiwi', self.collection.tag_set)
+
+    def test_tag_add_and_set(self):
+        self.collection.set_tags_from_tag_set(self.mixed_tag_set)
+
+        self.assertIn('lemon', self.collection.tag_set)
+
+        self.assertNotIn('banana', self.collection.tag_set)
+
+    def test_tag_count(self):
+        self.assertEqual(Tag.objects.count(), 12)
+        self.assertEqual(self.collection.tags.count(), 12)
+
+    def test_tag_removal(self):
+        self.collection.remove_tags_by_tag_set(self.tag_set_a)
+
+        self.assertEqual(self.collection.tags.count(), 9)
+
+    def test_tag_bool_methods(self):
+        self.collection.remove_tags_by_tag_set(self.tag_set_b)
+
+        self.assertTrue(self.collection.has_tags_in_tag_set(self.tag_set_c))
+        self.assertFalse(self.collection.has_tags_in_tag_set(self.mixed_tag_set))
+
+    def test_tag_matching_methods(self):
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.tag_set_a)), 3)
+
+        self.collection.remove_tags_by_tag_set(self.tag_set_a)
+
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.tag_set_a)), 0)
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.tag_set_b)), 3)
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.mixed_tag_set)), 2)
+
+        self.collection.remove_tags_by_tag_set(self.tag_set_b)
+
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.tag_set_b)), 0)
+
+        self.assertEqual(len(self.collection.get_matching_tags_from_tag_set(self.mixed_tag_set)), 1)
+
+    def test_tag_metric_methods(self):
+        self.assertAlmostEqual(
+            self.collection.get_matching_percentage_of_tag_set(self.tag_set_a),
+            1.00,
+            2
+        )
+
+        self.assertAlmostEqual(
+            self.collection.get_matching_percentage_of_model_tags_from_tag_set(self.tag_set_b),
+            0.25,
+            2
+        )
+
+        self.collection.remove_tags_by_tag_set(self.mixed_tag_set)
+
+        self.assertAlmostEqual(
+            self.collection.get_matching_percentage_of_tag_set(self.tag_set_a),
+            0.666,
+            2
+        )
+
+
+        self.assertAlmostEqual(
+            self.collection.get_matching_percentage_of_model_tags_from_tag_set(self.tag_set_b),
+            0.222,
+            2
+        )
+

django_spire/core/tags/tools.py

@@ -0,0 +1,20 @@
+def get_matching_tag_set_from_tag_sets(tag_set_a: set[str], tag_set_b: set[str]) -> set[str]:
+    return tag_set_a.intersection(tag_set_b)
+
+
+def get_matching_count_from_tag_sets(tag_set_a: set[str], tag_set_b: set[str]) -> int:
+    return len(get_matching_tag_set_from_tag_sets(tag_set_a, tag_set_b))
+
+
+def get_matching_a_percentage_from_tag_sets(tag_set_a: set[str], tag_set_b: set[str]) -> float:
+    try:
+        return get_matching_count_from_tag_sets(tag_set_a, tag_set_b) / len(tag_set_a)
+    except ZeroDivisionError:
+        return 0.0
+
+
+def get_matching_b_percentage_from_tag_sets(tag_set_a: set[str], tag_set_b: set[str]) -> float:
+    try:
+        return get_matching_count_from_tag_sets(tag_set_a, tag_set_b) / len(tag_set_b)
+    except ZeroDivisionError:
+        return 0.0

django_spire/knowledge/collection/admin.py

@@ -1,18 +1,35 @@
 from __future__ import annotations
 
 from django.contrib import admin
+from django.db.models import QuerySet
+from django.contrib import messages
 
 from .models import Collection, CollectionGroup
 
 
 @admin.register(Collection)
 class CollectionAdmin(admin.ModelAdmin):
-    list_display = ['id', 'name', 'parent', 'is_deleted']
+    list_display = ['id', 'name', 'parent', 'is_deleted', 'tag_count']
     list_select_related = ['parent']
     list_filter = ['is_deleted', 'is_active']
     search_fields = ['id', 'name', 'description', 'parent__name']
     ordering = ['name']
     autocomplete_fields = ['parent']
+    actions = ['set_tags_for_collections']
+
+    @admin.action(description="Set Tags for Collections (Allow 5 Seconds Per)")
+    def set_tags_for_collections(self, request, queryset: QuerySet[Collection]):
+        processed = 0
+        for collection in queryset:
+            collection.services.tag.process_and_set_tags()
+            processed += 1
+
+        messages.success(request, f'Successfully processed {processed} collections.')
+
+    def tag_count(self, collection: Collection):
+        return collection.tags.count()
+
+    tag_count.short_description = 'Tags'
 
 
 @admin.register(CollectionGroup)
@@ -20,3 +37,5 @@ class CollectionGroupAdmin(admin.ModelAdmin):
     list_display = ['id', 'collection', 'auth_group']
     list_select_related = ['collection', 'auth_group']
     search_fields = ['id', 'collection__name', 'auth_group__name']
+
+

django_spire/knowledge/collection/models.py

@@ -5,6 +5,7 @@ from django.db import models
 from django_spire.auth.group.models import AuthGroup
 from django_spire.contrib import Breadcrumbs
 from django_spire.contrib.ordering.mixins import OrderingModelMixin
+from django_spire.core.tags.mixins import TagsModelMixin
 from django_spire.contrib.utils import truncate_string
 from django_spire.history.mixins import HistoryModelMixin
 from django_spire.knowledge.collection.querysets import CollectionQuerySet
@@ -12,7 +13,11 @@ from django_spire.knowledge.collection.services.service import CollectionGroupSe
     CollectionService
 
 
-class Collection(HistoryModelMixin, OrderingModelMixin):
+class Collection(
+    HistoryModelMixin,
+    OrderingModelMixin,
+    TagsModelMixin,
+):
     parent = models.ForeignKey(
         'self',
         on_delete=models.CASCADE,

django_spire/knowledge/collection/services/service.py

@@ -10,6 +10,7 @@ from django_spire.knowledge.collection.services.ordering_service import \
     CollectionOrderingService
 from django_spire.knowledge.collection.services.processor_service import \
     CollectionProcessorService
+from django_spire.knowledge.collection.services.tag_service import CollectionTagService
 from django_spire.knowledge.collection.services.transformation_service import \
     CollectionTransformationService
 
@@ -22,6 +23,7 @@ class CollectionService(BaseDjangoModelService['Collection']):
 
     ordering = CollectionOrderingService()
     processor = CollectionProcessorService()
+    tag = CollectionTagService()
     transformation = CollectionTransformationService()
 
     def save_model_obj(self, **field_data) -> tuple[Collection, bool]: