ckanext-search-tweaks 0.6.1.post1__tar.gz → 0.6.3__tar.gz

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/MANIFEST.in

@@ -1,5 +1,5 @@
 include README.rst
 include LICENSE
 include requirements.txt
-recursive-include ckanext/search_tweaks *.html *.json *.js *.less *.css *.mo *.yml
+recursive-include ckanext/search_tweaks *.html *.json *.js *.less *.css *.mo *.yml *.yaml
 recursive-include ckanext/search_tweaks/migration *.ini *.py *.mako

{ckanext_search_tweaks-0.6.1.post1/ckanext_search_tweaks.egg-info → ckanext_search_tweaks-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ckanext-search-tweaks
-Version: 0.6.1.post1
+Version: 0.6.3
 Author-email: DataShades <datashades@linkdigital.com.au>, Sergey Motornyuk <sergey.motornyuk@linkdigital.com.au>
 Maintainer-email: DataShades <datashades@linkdigital.com.au>
 License: AGPL

ckanext_search_tweaks-0.6.3/ckanext/search_tweaks/config_declaration.yaml

@@ -0,0 +1,24 @@
+version: 1
+groups:
+  - annotation: "ckanext-search-tweaks: common"
+    options:
+      - key: ckanext.search_tweaks.common.qf
+        placeholder: "name^4 title^4 tags^2 groups^2 text"
+
+      - key: ckanext.search_tweaks.common.mm
+        default: "1"
+
+      - key: ckanext.search_tweaks.common.fuzzy_search.enabled
+        type: bool
+
+      - key: ckanext.search_tweaks.common.fuzzy_search.distance
+        type: int
+        default: 1
+
+      - key: ckanext.search_tweaks.common.fuzzy_search.keep_original
+        type: bool
+        default: true
+
+      - key: ckanext.search_tweaks.common.prefer_boost
+        type: bool
+        default: true

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext/search_tweaks/field_relevance/plugin.py

@@ -15,10 +15,10 @@ CONFIG_BOOST_FN = "ckanext.search_tweaks.field_relevance.boost_function"
 DEFAULT_BOOST_FN = None
 
 
+@tk.blanket.blueprints
 class FieldRelevancePlugin(p.SingletonPlugin):
     p.implements(ISearchTweaks, inherit=True)
     p.implements(p.IAuthFunctions)
-    p.implements(p.IBlueprint)
     p.implements(p.IConfigurer, inherit=True)
 
     # ISearchTweaks
@@ -28,11 +28,6 @@ class FieldRelevancePlugin(p.SingletonPlugin):
 
         return tk.config.get(CONFIG_BOOST_FN, DEFAULT_BOOST_FN)
 
-    # IBlueprint
-
-    def get_blueprint(self):
-        return views.get_blueprints()
-
     # IConfigurer
 
     def update_config(self, config):

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext/search_tweaks/field_relevance/templates/search_tweaks/field_relevance/promote.html

@@ -17,7 +17,7 @@
 	<form id="dataset-edit" class="dataset-form" method="post" action="{{ action }}" data-module="basic-form" novalidate>
 
 	    {% call form.input_block(field_name, _("Promotion level"), errors[field_name], classes=["search-tweaks-label-with-value"]) %}
-		<input data-module="search-tweaks-reflect-range-in-label" data-module-format=" (%d)" id="{{ field_name }}" type="range" name="{{ field_name }}" value="{{ data[field_name] }}" max="{{ max_promotion }}" />
+		<input data-module="search-tweaks-reflect-range-in-label" data-module-format=" (%d)" id="{{ field_name }}" type="range" name="{{ field_name }}" value="{{ data[field_name] }}" min="{{ min_promotion }}" max="{{ max_promotion }}" />
 	    {% endcall %}
 
 	    {% block form_actions %}

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext/search_tweaks/field_relevance/views.py

@@ -12,6 +12,9 @@ CONFIG_ENABLE_PROMOTION_ROUTE = (
     "ckanext.search_tweaks.field_relevance.blueprint.promotion.enabled"
 )
 CONFIG_PROMOTION_PATH = "ckanext.search_tweaks.field_relevance.blueprint.promotion.path"
+CONFIG_MIN_PROMOTION = (
+    "ckanext.search_tweaks.field_relevance.blueprint.promotion.min_value"
+)
 CONFIG_MAX_PROMOTION = (
     "ckanext.search_tweaks.field_relevance.blueprint.promotion.max_value"
 )
@@ -21,22 +24,13 @@ CONFIG_PROMOTION_FIELD = (
 
 DEFAULT_ENABLE_PROMOTION_ROUTE = False
 DEFAULT_PROMOTION_PATH = "/dataset/promote/<id>"
+DEFAULT_MIN_PROMOTION = 0
 DEFAULT_MAX_PROMOTION = 100
 DEFAULT_PROMOTION_FIELD = "promotion_level"
 
 field_relevance = Blueprint("search_tweaks_field_relevance", __name__)
 
 
-def get_blueprints():
-    if tk.asbool(
-        tk.config.get(CONFIG_ENABLE_PROMOTION_ROUTE, DEFAULT_ENABLE_PROMOTION_ROUTE),
-    ):
-        path = tk.config.get(CONFIG_PROMOTION_PATH, DEFAULT_PROMOTION_PATH)
-        field_relevance.add_url_rule(path, view_func=PromoteView.as_view("promote"))
-
-    return [field_relevance]
-
-
 class PromoteView(MethodView):
     def _check_access(self, id: str) -> None:
         try:
@@ -50,7 +44,7 @@ class PromoteView(MethodView):
         schema = {
             field: [
                 tk.get_validator("convert_int"),
-                tk.get_validator("natural_number_validator"),
+                tk.get_validator("int_validator"),
                 tk.get_validator("limit_to_configured_maximum")(
                     CONFIG_MAX_PROMOTION, DEFAULT_MAX_PROMOTION,
                 ),
@@ -89,6 +83,10 @@ class PromoteView(MethodView):
             "pkg_dict": pkg_dict,
             "errors": errors or {},
             "data": data or pkg_dict,
+            "min_promotion": tk.asint(
+                tk.config.get(CONFIG_MIN_PROMOTION, DEFAULT_MIN_PROMOTION),
+            ),
+
             "max_promotion": tk.asint(
                 tk.config.get(CONFIG_MAX_PROMOTION, DEFAULT_MAX_PROMOTION),
             ),
@@ -96,3 +94,9 @@ class PromoteView(MethodView):
         }
 
         return tk.render("search_tweaks/field_relevance/promote.html", extra_vars)
+
+
+if tk.asbool(
+    tk.config.get(CONFIG_ENABLE_PROMOTION_ROUTE, DEFAULT_ENABLE_PROMOTION_ROUTE),
+):
+    field_relevance.add_url_rule("/dataset/promote/<id>", view_func=PromoteView.as_view("promote"))

ckanext_search_tweaks-0.6.3/ckanext/search_tweaks/query_popularity/config_declaration.yaml

@@ -0,0 +1,29 @@
+version: 1
+groups:
+  - annotation: "ckanext-search-tweaks: query popularity"
+    options:
+      - key: ckanext.search_tweaks.query_popularity.skip_irrefutable_search
+        type: bool
+        default: true
+
+      - key: ckanext.search_tweaks.query_popularity.ignored_symbols
+        default: ":"
+
+      - key: ckanext.search_tweaks.query_popularity.ignored_terms
+        type: list
+
+      - key: ckanext.search_tweaks.query_popularity.tracked_endpoints
+        type: list
+        default: dataset.search
+
+      - key: ckanext.search_tweaks.query_popularity.query_throttle
+        type: int
+        default: 86_400 # 24 hours
+
+      - key: ckanext.search_tweaks.query_popularity.max_age
+        type: int
+        default: 2_592_000 # 30 days
+
+      - key: ckanext.search_tweaks.query_popularity.obsoletion_period
+        type: int
+        default: 86_400 # 24 hours

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext/search_tweaks/query_relevance/cli.py

@@ -1,16 +1,21 @@
+from __future__ import annotations
+
 import csv
 import datetime
-
+import logging
 import click
 import freezegun
 
 import ckan.model as model
 from ckan.lib.redis import connect_to_redis
+from ckan.lib.search import rebuild
 
 from . import QueryScore
 
 _search_csv_headers = ["package_id", "search_query", "count_of_hits"]
 
+log = logging.getLogger(__name__)
+
 
 @click.group(short_help="Manage search relevance")
 def query():
@@ -86,3 +91,18 @@ def safe_export(ctx, days, file):
             fg="red",
         )
         ctx.invoke(import_source, source=click.File()(file))
+
+
+@query.command()
+def index():
+    """Re-index datasets that have query relevance scores.
+    """
+
+    storage = QueryScore.default_storage_class()
+    ids = {id for id, _, _ in storage.scan()}
+    with click.progressbar(ids) as bar:
+        for id in bar:
+            try:
+                rebuild(id)
+            except Exception:
+                log.exception("Cannot index %s", id)

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext/search_tweaks/query_relevance/plugin.py

@@ -49,24 +49,14 @@ class QueryRelevancePlugin(plugins.SingletonPlugin):
     # ISearchTweaks
 
     def get_search_boost_fn(self, search_params: dict[str, Any]) -> str | None:
-        if feature_disabled("query_boost", search_params):
-            return None
-
-        prefix = tk.config.get(CONFIG_RELEVANCE_PREFIX, DEFAULT_RELEVANCE_PREFIX)
-        disabled = tk.asbool(
-            search_params.get("extras", {}).get(
-                "ext_search_tweaks_disable_relevance",
-                False,
-            ),
-        )
-
-        if not search_params.get("q") or disabled:
+        if feature_disabled("query_boost", search_params) or not search_params.get("q"):
             return None
 
         normalized = normalize_query(search_params["q"]).replace(" ", "_")
         if not normalized:
             return None
 
+        prefix = tk.config.get(CONFIG_RELEVANCE_PREFIX, DEFAULT_RELEVANCE_PREFIX)
         field = prefix + normalized
         boost_string = Template(
             tk.config.get(CONFIG_BOOST_STRING, DEFAULT_BOOST_STRING),

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3/ckanext_search_tweaks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ckanext-search-tweaks
-Version: 0.6.1.post1
+Version: 0.6.3
 Author-email: DataShades <datashades@linkdigital.com.au>, Sergey Motornyuk <sergey.motornyuk@linkdigital.com.au>
 Maintainer-email: DataShades <datashades@linkdigital.com.au>
 License: AGPL

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/ckanext_search_tweaks.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ ckanext/__init__.py
 ckanext/search_tweaks/__init__.py
 ckanext/search_tweaks/cli.py
 ckanext/search_tweaks/config.py
+ckanext/search_tweaks/config_declaration.yaml
 ckanext/search_tweaks/interfaces.py
 ckanext/search_tweaks/plugin.py
 ckanext/search_tweaks/shared.py
@@ -26,6 +27,7 @@ ckanext/search_tweaks/field_relevance/assets/webassets.yml
 ckanext/search_tweaks/field_relevance/templates/search_tweaks/field_relevance/promote.html
 ckanext/search_tweaks/query_popularity/__init__.py
 ckanext/search_tweaks/query_popularity/config.py
+ckanext/search_tweaks/query_popularity/config_declaration.yaml
 ckanext/search_tweaks/query_popularity/plugin.py
 ckanext/search_tweaks/query_popularity/score.py
 ckanext/search_tweaks/query_popularity/logic/__init__.py

{ckanext_search_tweaks-0.6.1.post1 → ckanext_search_tweaks-0.6.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ckanext-search-tweaks"
-version = "0.6.1.post1"
+version = "0.6.3"
 description = ""
 classifiers = [ "Development Status :: 4 - Beta", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10",]
 keywords = [ "CKAN",]