openedx-learning 0.1.1__py2.py3-none-any.whl → 0.1.2__py2.py3-none-any.whl

openedx_learning/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"

{openedx_learning-0.1.1.dist-info → openedx_learning-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.1.1
+Version: 0.1.2
 Summary: An experiment.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,8 +18,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Requires-Dist: djangorestframework (<4.0)
-Requires-Dist: Django (<5.0)
+Requires-Dist: edx-drf-extensions
 Requires-Dist: rules (<4.0)
+Requires-Dist: Django (<5.0)
 
 openedx-learning
 =============================

{openedx_learning-0.1.1.dist-info → openedx_learning-0.1.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-openedx_learning/__init__.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
+openedx_learning/__init__.py,sha256=YvuYzWnKtqBb-IqG8HAu-nhIYAsgj9Vmc_b9o7vO-js,22
 openedx_learning/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/contrib/media_server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/contrib/media_server/apps.py,sha256=DWPy77j5hdv_tk8Y9MsoscgwRBxplO-sBVJT5grhHPA,754
@@ -41,7 +41,7 @@ openedx_learning/rest_api/v1/urls.py,sha256=lY-i3VzANvtdcJHjwygMtqEhfyMOjgIfaWpn
 openedx_tagging/__init__.py,sha256=N_pklgjdCZO62lWysvHk0w9RnDRXCBVhok0GheQrFaE,28
 openedx_tagging/core/tagging/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/tagging/admin.py,sha256=efVW_mA5MEey14VJdazacyxnBgbYPPfJQVS7XLKaWEg,192
-openedx_tagging/core/tagging/api.py,sha256=IL5ACbyaOKMaYsOz1s_1JScpTfqCTDbOEfosuWa0OAM,4393
+openedx_tagging/core/tagging/api.py,sha256=ilRZVGWPq2AtQkF6n_jeiwOPIKEDvTbkYrneUiuEeXw,6602
 openedx_tagging/core/tagging/apps.py,sha256=-gp0VYqX4XQzwjjd-G68Ev2Op0INLh9Byz5UOqF5_7k,345
 openedx_tagging/core/tagging/rules.py,sha256=_a5waGxbHmAvSeFG6SefRCF4hpVdCw1hlJuyd440X_k,2688
 openedx_tagging/core/tagging/urls.py,sha256=XOZ0CNp7w1Z4zcTZ9orX-uEfqogCRYTpLhVkNG8yfw8,159
@@ -53,18 +53,19 @@ openedx_tagging/core/tagging/migrations/0002_auto_20230718_2026.py,sha256=UG_q6U
 openedx_tagging/core/tagging/migrations/0003_auto_20230721_1238.py,sha256=c8q2apdZPNcr9U4VstFaLSO5z1k0ZlzL87qObobN7Mw,2109
 openedx_tagging/core/tagging/migrations/0004_auto_20230723_2001.py,sha256=Onnc6T12BxOQX5QTFUC9Qc5leiR7014qT2jVE7N8MBU,1080
 openedx_tagging/core/tagging/migrations/0005_language_taxonomy.py,sha256=WaWh4JAnbPCqPo2uFRWHPZfUC1wa9zgGuLU8Qgri68U,708
+openedx_tagging/core/tagging/migrations/0006_alter_objecttag_unique_together.py,sha256=Jx7B8ZQ5u8sZksKEkpZFrcaQpBXkaJVBtTXa-k3c4xY,376
 openedx_tagging/core/tagging/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/tagging/models/__init__.py,sha256=2THzqS9MSZvFiKTh_tGTjzXPw0GRoP7BleQMvhEJkqw,197
-openedx_tagging/core/tagging/models/base.py,sha256=XCUT9jtbK87UFqY-wNDt3vaxXr30P7wNgZt0vMIHwEg,22815
+openedx_tagging/core/tagging/models/base.py,sha256=OYNMHqB2UHhgoAFv6E66KqtzSolsoguA337hQxMmZVU,25000
 openedx_tagging/core/tagging/models/system_defined.py,sha256=o-x-ckdbiGSjLWQu0DJJsm5nETCuW4i9pPOPo-yqfxY,8422
 openedx_tagging/core/tagging/rest_api/urls.py,sha256=HWK1uWlslaBeqcPdlgvRjcSk0_lm48Sq3cR3TPvTiKk,148
 openedx_tagging/core/tagging/rest_api/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/tagging/rest_api/v1/permissions.py,sha256=xfiSuGzJ6b01XWzdPrbZWlJAAC8zjaEDhV6W7y_pq0Y,536
 openedx_tagging/core/tagging/rest_api/v1/serializers.py,sha256=NX9AAVVTT9EChTIshLvitwej-TO1UJEt6VB5vgTR2y0,693
 openedx_tagging/core/tagging/rest_api/v1/urls.py,sha256=Fc2nN4yFLZeKFOPPMYU_bXxNxd3Cw2gGXxiIJd5rV0c,292
-openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=lVFG04C5uonyGpjJnuoLqeo54jYSWXM-PiOMnW3hvFc,5757
-openedx_learning-0.1.1.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
-openedx_learning-0.1.1.dist-info/METADATA,sha256=IPVuHfTujw9uO1-9M0TZrEAXFujuiqhBRhx_pyb7AA4,8606
-openedx_learning-0.1.1.dist-info/WHEEL,sha256=Z-nyYpwrcSqxfdux5Mbn_DQ525iP7J2DG3JgGvOYyTQ,110
-openedx_learning-0.1.1.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.1.1.dist-info/RECORD,,
+openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=uUl_aNEGVTu1vj36HWpZjQfw154Qq-iEGNpQ-0koZVs,5881
+openedx_learning-0.1.2.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.1.2.dist-info/METADATA,sha256=xgX75erxBaiHLfBiefAd-j2VPJiws5LdA9yBt8OlfKI,8640
+openedx_learning-0.1.2.dist-info/WHEEL,sha256=Z-nyYpwrcSqxfdux5Mbn_DQ525iP7J2DG3JgGvOYyTQ,110
+openedx_learning-0.1.2.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.1.2.dist-info/RECORD,,

openedx_tagging/core/tagging/api.py

@@ -137,3 +137,46 @@ def tag_object(
     Preserves existing (valid) tags, adds new (valid) tags, and removes omitted (or invalid) tags.
     """
     return taxonomy.cast().tag_object(tags, object_id)
+
+
+def autocomplete_tags(
+    taxonomy: Taxonomy,
+    search: str,
+    object_id: str = None,
+    object_tags_only=True,
+) -> QuerySet:
+    """
+    Provides auto-complete suggestions by matching the `search` string against existing
+    ObjectTags linked to the given taxonomy. A case-insensitive search is used in order
+    to return the highest number of relevant tags.
+
+    If `object_id` is provided, then object tag values already linked to this object
+    are omitted from the returned suggestions. (ObjectTag values must be unique for a
+    given object + taxonomy, and so omitting these suggestions helps users avoid
+    duplication errors.).
+
+    Returns a QuerySet of dictionaries containing distinct `value` (string) and
+    `tag` (numeric ID) values, sorted alphabetically by `value`.
+    The `value` is what should be shown as a suggestion to users,
+    and if it's a free-text taxonomy, `tag` will be `None`:  we include the `tag` ID
+    in anticipation of the second use case listed below.
+
+    Use cases:
+    * This method is useful for reducing tag variation in free-text taxonomies by showing
+      users tags that are similar to what they're typing. E.g., if the `search` string "dn"
+      shows that other objects have been tagged with "DNA", "DNA electrophoresis", and "DNA fingerprinting",
+      this encourages users to use those existing tags if relevant, instead of creating new ones that
+      look similar (e.g. "dna finger-printing").
+    * It could also be used to assist tagging for closed taxonomies with a list of possible tags which is too
+      large to return all at once, e.g. a user model taxonomy that dynamically creates tags on request for any
+      registered user in the database. (Note that this is not implemented yet, but may be as part of a future change.)
+    """
+    if not object_tags_only:
+        raise NotImplementedError(
+            _(
+                "Using this would return a query set of tags instead of object tags."
+                "For now we recommend fetching all of the taxonomy's tags "
+                "using get_tags() and filtering them on the frontend."
+            )
+        )
+    return taxonomy.cast().autocomplete_tags(search, object_id)

openedx_tagging/core/tagging/migrations/0006_alter_objecttag_unique_together.py

@@ -0,0 +1,16 @@
+# Generated by Django 3.2.19 on 2023-08-02 16:20
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("oel_tagging", "0005_language_taxonomy"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="objecttag",
+            unique_together={("taxonomy", "_value", "object_id")},
+        ),
+    ]

openedx_tagging/core/tagging/models/base.py

@@ -430,6 +430,52 @@ class Taxonomy(models.Model):
 
         return updated_tags
 
+    def autocomplete_tags(
+        self,
+        search: str,
+        object_id: str = None,
+    ) -> models.QuerySet:
+        """
+        Provides auto-complete suggestions by matching the `search` string against existing
+        ObjectTags linked to the given taxonomy. A case-insensitive search is used in order
+        to return the highest number of relevant tags.
+
+        If `object_id` is provided, then object tag values already linked to this object
+        are omitted from the returned suggestions. (ObjectTag values must be unique for a
+        given object + taxonomy, and so omitting these suggestions helps users avoid
+        duplication errors.).
+
+        Returns a QuerySet of dictionaries containing distinct `value` (string) and `tag`
+        (numeric ID) values, sorted alphabetically by `value`.
+
+        Subclasses can override this method to perform their own autocomplete process.
+        Subclass use cases:
+        * Large taxonomy associated with a model. It can be overridden to get
+          the suggestions directly from the model by doing own filtering.
+        * Taxonomy with a list of available tags: It can be overridden to only
+          search the suggestions on a list of available tags.
+        """
+        # Fetch tags that the object already has to exclude them from the result
+        excluded_tags = []
+        if object_id:
+            excluded_tags = self.objecttag_set.filter(object_id=object_id).values_list(
+                "_value", flat=True
+            )
+        return (
+            # Fetch object tags from this taxonomy whose value contains the search
+            self.objecttag_set.filter(_value__icontains=search)
+            # omit any tags whose values match the tags on the given object
+            .exclude(_value__in=excluded_tags)
+            # alphabetical ordering
+            .order_by("_value")
+            # Alias the `_value` field to `value` to make it nicer for users
+            .annotate(value=models.F("_value"))
+            # obtain tag values
+            .values("value", "tag_id")
+            # remove repeats
+            .distinct()
+        )
+
 
 class ObjectTag(models.Model):
     """
@@ -497,6 +543,7 @@ class ObjectTag(models.Model):
             models.Index(fields=["taxonomy", "object_id"]),
             models.Index(fields=["taxonomy", "_value"]),
         ]
+        unique_together = ("taxonomy", "_value", "object_id")
 
     def __repr__(self):
         """

openedx_tagging/core/tagging/rest_api/v1/views.py

@@ -9,8 +9,8 @@ from ...api import (
     get_taxonomy,
     get_taxonomies,
 )
-from .serializers import TaxonomyListQueryParamsSerializer, TaxonomySerializer
 from .permissions import TaxonomyObjectPermissions
+from .serializers import TaxonomyListQueryParamsSerializer, TaxonomySerializer
 
 
 class TaxonomyView(ModelViewSet):
@@ -19,6 +19,8 @@ class TaxonomyView(ModelViewSet):
 
     **List Query Parameters**
         * enabled (optional) - Filter by enabled status. Valid values: true, false, 1, 0, "true", "false", "1"
+        * page (optional) - Page number (default: 1)
+        * page_size (optional) - Number of items per page (default: 10)
 
     **List Example Requests**
         GET api/tagging/v1/taxonomy                                                 - Get all taxonomies
@@ -59,7 +61,6 @@ class TaxonomyView(ModelViewSet):
             "allow_free_text": True,
         }
 
-
     **Create Query Returns**
         * 201 - Success
         * 403 - Permission denied