openedx-learning 0.1.0__tar.gz → 0.1.2__tar.gz

{openedx-learning-0.1.0 → openedx-learning-0.1.2}/MANIFEST.in

@@ -3,4 +3,4 @@ include LICENSE.txt
 include README.rst
 include requirements/base.in
 recursive-include openedx_learning *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py
-recursive-include openedx_tagging *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py
+recursive-include openedx_tagging *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py *.yaml

{openedx-learning-0.1.0/openedx_learning.egg-info → openedx-learning-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: openedx-learning
-Version: 0.1.0
+Version: 0.1.2
 Summary: An experiment.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee

openedx-learning-0.1.2/openedx_learning/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.2"

{openedx-learning-0.1.0 → openedx-learning-0.1.2/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: openedx-learning
-Version: 0.1.0
+Version: 0.1.2
 Summary: An experiment.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee

{openedx-learning-0.1.0 → openedx-learning-0.1.2}/openedx_learning.egg-info/SOURCES.txt

@@ -55,9 +55,25 @@ openedx_tagging/core/tagging/__init__.py
 openedx_tagging/core/tagging/admin.py
 openedx_tagging/core/tagging/api.py
 openedx_tagging/core/tagging/apps.py
-openedx_tagging/core/tagging/models.py
 openedx_tagging/core/tagging/rules.py
+openedx_tagging/core/tagging/urls.py
+openedx_tagging/core/tagging/fixtures/language_taxonomy.yaml
+openedx_tagging/core/tagging/management/commands/__init__.py
+openedx_tagging/core/tagging/management/commands/build_language_fixture.py
 openedx_tagging/core/tagging/migrations/0001_initial.py
 openedx_tagging/core/tagging/migrations/0002_auto_20230718_2026.py
+openedx_tagging/core/tagging/migrations/0003_auto_20230721_1238.py
+openedx_tagging/core/tagging/migrations/0004_auto_20230723_2001.py
+openedx_tagging/core/tagging/migrations/0005_language_taxonomy.py
+openedx_tagging/core/tagging/migrations/0006_alter_objecttag_unique_together.py
 openedx_tagging/core/tagging/migrations/__init__.py
+openedx_tagging/core/tagging/models/__init__.py
+openedx_tagging/core/tagging/models/base.py
+openedx_tagging/core/tagging/models/system_defined.py
+openedx_tagging/core/tagging/rest_api/urls.py
+openedx_tagging/core/tagging/rest_api/v1/__init__.py
+openedx_tagging/core/tagging/rest_api/v1/permissions.py
+openedx_tagging/core/tagging/rest_api/v1/serializers.py
+openedx_tagging/core/tagging/rest_api/v1/urls.py
+openedx_tagging/core/tagging/rest_api/v1/views.py
 requirements/base.in

{openedx-learning-0.1.0 → openedx-learning-0.1.2}/openedx_learning.egg-info/requires.txt

@@ -1,3 +1,4 @@
-Django<5.0
-rules<4.0
 djangorestframework<4.0
+edx-drf-extensions
+rules<4.0
+Django<5.0

{openedx-learning-0.1.0 → openedx-learning-0.1.2}/openedx_tagging/core/tagging/api.py

@@ -106,8 +106,9 @@ def get_object_tags(
     Pass valid_only=False when displaying tags to content authors, so they can see invalid tags too.
     Invalid tags will (probably) be hidden from learners.
     """
+    ObjectTagClass = taxonomy.object_tag_class if taxonomy else ObjectTag
     tags = (
-        ObjectTag.objects.filter(
+        ObjectTagClass.objects.filter(
             object_id=object_id,
         )
         .select_related("tag", "taxonomy")
@@ -136,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)