ckanext-versioned-tiledmap 2.3.2__tar.gz → 2.3.4__tar.gz

{ckanext_versioned_tiledmap-2.3.2/ckanext_versioned_tiledmap.egg-info → ckanext_versioned_tiledmap-2.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ckanext-versioned-tiledmap
-Version: 2.3.2
+Version: 2.3.4
 Summary: A CKAN extension with a map view for versioned-datastore backed resources.
 Author-email: Natural History Museum <data@nhm.ac.uk>
 License: GPL-3.0-or-later
@@ -18,20 +18,25 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ckanext-versioned-datastore>=3.7.0
-Requires-Dist: ckantools>=0.3.0
 Requires-Dist: cachetools>=4.2.4
+Requires-Dist: ckantools>=0.4.2
 Provides-Extra: test
 Requires-Dist: mock; extra == "test"
 Requires-Dist: pytest>=4.6.5; extra == "test"
 Requires-Dist: pytest-cov>=2.7.1; extra == "test"
 Requires-Dist: coveralls; extra == "test"
+Dynamic: license-file
 
 <!--header-start-->
-<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
+  <img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
+</picture>
 
 # ckanext-versioned-tiledmap
 
-[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/main.yml)
+[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/tests.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/tests.yml)
 [![Coveralls](https://img.shields.io/coveralls/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main?style=flat-square)](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap)
 [![CKAN](https://img.shields.io/badge/ckan-2.9.7-orange.svg?style=flat-square)](https://github.com/ckan/ckan)
 [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg?style=flat-square)](https://www.python.org/)

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/README.md

@@ -1,9 +1,13 @@
 <!--header-start-->
-<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
+  <img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
+</picture>
 
 # ckanext-versioned-tiledmap
 
-[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/main.yml)
+[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/tests.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/tests.yml)
 [![Coveralls](https://img.shields.io/coveralls/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main?style=flat-square)](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap)
 [![CKAN](https://img.shields.io/badge/ckan-2.9.7-orange.svg?style=flat-square)](https://github.com/ckan/ckan)
 [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg?style=flat-square)](https://www.python.org/)

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/lib/helpers.py

@@ -12,11 +12,12 @@ def mustache_wrapper(s):
 
 
 def dwc_field_title(field):
-    '''
+    """
     Convert a DwC field name into a label - split on uppercase
-    @param field:
-    @return: str label
-    '''
+
+    :param field:
+    :returns: str label
+    """
     title = re.sub('([A-Z]+)', r' \1', field)
     title = f'{title[0].upper()}{title[1:]}'
     return title

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/lib/utils.py

@@ -4,9 +4,10 @@
 # This file is part of a project
 # Created by the Natural History Museum in London, UK
 
-from ckan.plugins import toolkit
 import urllib.request
-from cachetools import cached, TTLCache
+
+from cachetools import TTLCache, cached
+from ckan.plugins import toolkit
 
 
 def get_resource_datastore_fields(resource_id):
@@ -32,4 +33,4 @@ def get_tileserver_status():
         else:
             tileserver_response_text = 'unavailable'
 
-    return tileserver_response_text
+    return tileserver_response_text

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/lib/validators.py

@@ -7,6 +7,7 @@
 import re
 
 from ckan.plugins import toolkit
+
 from ckanext.tiledmap.lib.utils import get_resource_datastore_fields
 
 
@@ -16,7 +17,7 @@ def colour_validator(value, context):
 
     :param value: the value to validate
     :param context: the context within which this validation is taking place
-    :return: the validated value
+    :returns: the validated value
     """
     if re.match('^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$', value):
         if value[0] != '#':
@@ -38,7 +39,7 @@ def float_01_validator(value, context):
 
     :param value: the value
     :param context: the context within which this validation is taking place
-    :return: the validated value
+    :returns: the validated value
     """
     try:
         value = float(value)
@@ -55,7 +56,7 @@ def is_datastore_field(value, context):
 
     :param value: the value to validate
     :param context: the context within which this validation is taking place
-    :return: the value
+    :returns: the value
     """
     passed_fields = value if isinstance(value, list) else [value]
     fields = get_resource_datastore_fields(toolkit.g.resource['id'])
@@ -71,7 +72,7 @@ def is_view_id(value, context):
 
     :param value: the value to validate
     :param context: the context within which this validation is taking place
-    :return: the value
+    :returns: the value
     """
     if value:
         data = {'id': toolkit.g.resource['id']}

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/plugin.py

@@ -4,15 +4,18 @@
 # This file is part of a project
 # Created by the Natural History Museum in London, UK
 
+
 from ckan.common import json
-from ckan.plugins import toolkit, implements, interfaces, SingletonPlugin
+from ckan.plugins import SingletonPlugin, implements, interfaces, toolkit
 
 from ckanext.tiledmap import routes
 from ckanext.tiledmap.config import config as plugin_config
 from ckanext.tiledmap.lib import validators
-from ckanext.tiledmap.lib.helpers import mustache_wrapper, dwc_field_title
-from ckanext.tiledmap.lib.utils import get_resource_datastore_fields, get_tileserver_status
-import urllib.request
+from ckanext.tiledmap.lib.helpers import dwc_field_title, mustache_wrapper
+from ckanext.tiledmap.lib.utils import (
+    get_resource_datastore_fields,
+    get_tileserver_status,
+)
 
 try:
     from ckanext.status.interfaces import IStatus

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/routes/_helpers.py

@@ -12,6 +12,7 @@ from urllib.parse import unquote
 
 from ckan.common import json
 from ckan.plugins import toolkit
+
 from ckanext.tiledmap.config import config
 
 
@@ -21,12 +22,12 @@ class MapViewSettings:
     """
 
     def __init__(self, fetch_id, view, resource):
-        '''
+        """
         :param fetch_id: the id of the request, as provided by the javascript module. This is used
                          to keep track on the javascript side of the order map-info requests.
         :param view: the view dict
         :param resource: the resource dict
-        '''
+        """
         self.fetch_id = fetch_id
         self.view = view
         self.resource = resource
@@ -73,7 +74,7 @@ class MapViewSettings:
         Returns True if at least one of the map styles (plot, grid, heat) is enabled. If
         none of them are, returns False.
 
-        :return: True if one map style is enabled, False if none are
+        :returns: True if one map style is enabled, False if none are
         """
         return self.plot_map_enabled or self.grid_map_enabled or self.heat_map_enabled
 
@@ -85,7 +86,7 @@ class MapViewSettings:
 
         :param name: the name of the template
         :param extra_vars: a dict of variables to pass to the template renderer
-        :return: a rendered template
+        :returns: a rendered template
         """
         # this is the base name of the template, if there's no format version available then we'll
         # just return this
@@ -105,7 +106,7 @@ class MapViewSettings:
         """
         Renders the point info template and returns the result.
 
-        :return: the rendered point info template
+        :returns: the rendered point info template
         """
         return self._render_template(
             config['versioned_tilemap.info_template'],
@@ -120,7 +121,7 @@ class MapViewSettings:
         """
         Renders the point hover info template and returns the result.
 
-        :return: the rendered point hover info template
+        :returns: the rendered point hover info template
         """
         return self._render_template(
             config['versioned_tilemap.quick_info_template'],
@@ -137,9 +138,9 @@ class MapViewSettings:
         retrieved from the config object.
 
         :param style: the name of the style (plot, gridded or heatmap)
-        :param names: the names of the parameters to retrieve, these are also used as the names in
-                      the dict that the parameter values are stored under
-        :return: a dict
+        :param names: the names of the parameters to retrieve, these are also used as
+            the names in the dict that the parameter values are stored under
+        :returns: a dict
         """
         params = {}
         for name in names:
@@ -161,7 +162,7 @@ class MapViewSettings:
               (e.g. [[0, 4], [70, 71]]). This is how it is returned by the datastore_query_extent
               action.
 
-        :return: a 3-tuple - (int, int, list)
+        :returns: a 3-tuple - (int, int, list)
         """
         q, filters = extract_q_and_filters()
         # get query extent and counts
@@ -199,7 +200,7 @@ class MapViewSettings:
             - the query body is then sent along with all tile requests to the tile server, which
               decompresses it and uses it to search elasticsearch
 
-        :return: a url safe base64 encoded, gzipped, JSON string
+        :returns: a url safe base64 encoded, gzipped, JSON string
         """
         q, filters = extract_q_and_filters()
         result = toolkit.get_action('datastore_search')(
@@ -220,7 +221,7 @@ class MapViewSettings:
         Using the settings available on this object, create the /map-info response dict
         and return it.
 
-        :return: a dict
+        :returns: a dict
         """
         # get the standard map info dict (this provides a fresh one each time it's called)
         map_info = get_base_map_info()
@@ -324,7 +325,7 @@ def build_url(*parts):
     Given a bunch of parts, build a URL by joining them together with a /.
 
     :param parts: the URL parts
-    :return: a URL string
+    :returns: a URL string
     """
     return '/'.join(part.strip('/') for part in parts)
 
@@ -334,7 +335,8 @@ def extract_q_and_filters():
     Extract the q and filters query string parameters from the request. These are
     standard parameters in the resource views and have a standardised format too.
 
-    :return: a 2-tuple of the q value (string, or None) and the filters value (dict, or None)
+    :returns: a 2-tuple of the q value (string, or None) and the filters value (dict, or
+        None)
     """
     # get the query if there is one
     q = (
@@ -364,10 +366,11 @@ def get_base_map_info():
     running CKAN instance (they use either always static values or ones that are pulled
     from the config which can are set on boot).
 
-    A few settings are missing, these are set in MapViewSettings.create_map_info as they require
-    custom per-map settings that the user has control over or are dependant on the target resource.
+    A few settings are missing, these are set in MapViewSettings.create_map_info as they
+    require custom per-map settings that the user has control over or are dependant on
+    the target resource.
 
-    :return: a dict of settings
+    :returns: a dict of settings
     """
     png_url = build_url(config['versioned_tilemap.tile_server'], '/{z}/{x}/{y}.png')
     utf_grid_url = build_url(

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/routes/map.py

@@ -16,7 +16,7 @@ def info():
     """
     Returns metadata about a given map in JSON form.
 
-    :return: A JSON encoded string representing the metadata
+    :returns: A JSON encoded string representing the metadata
     """
     view_settings = _helpers.MapViewSettings.from_request()
 

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext/tiledmap/theme/assets/less/maps.less

@@ -51,7 +51,10 @@ div.tiled-map-info {
 .info {
   color: #555;
   padding: 6px 8px;
-  font: 14px/16px Arial, Helvetica, sans-serif;
+  font:
+    14px/16px Arial,
+    Helvetica,
+    sans-serif;
   background: rgba(255, 255, 255, 0.95);
   box-shadow: 0 0 15px rgba(0, 0, 0, 0.7);
   border-radius: 10px;
@@ -62,7 +65,10 @@ div.tiled-map-info {
 .small-info {
   color: #555;
   padding: 6px 8px;
-  font: 14px/16px Arial, Helvetica, sans-serif;
+  font:
+    14px/16px Arial,
+    Helvetica,
+    sans-serif;
   background: rgba(255, 255, 255, 0.95);
   box-shadow: 0 0 15px rgba(0, 0, 0, 0.7);
   border-radius: 10px;

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4/ckanext_versioned_tiledmap.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ckanext-versioned-tiledmap
-Version: 2.3.2
+Version: 2.3.4
 Summary: A CKAN extension with a map view for versioned-datastore backed resources.
 Author-email: Natural History Museum <data@nhm.ac.uk>
 License: GPL-3.0-or-later
@@ -18,20 +18,25 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ckanext-versioned-datastore>=3.7.0
-Requires-Dist: ckantools>=0.3.0
 Requires-Dist: cachetools>=4.2.4
+Requires-Dist: ckantools>=0.4.2
 Provides-Extra: test
 Requires-Dist: mock; extra == "test"
 Requires-Dist: pytest>=4.6.5; extra == "test"
 Requires-Dist: pytest-cov>=2.7.1; extra == "test"
 Requires-Dist: coveralls; extra == "test"
+Dynamic: license-file
 
 <!--header-start-->
-<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
+  <img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
+</picture>
 
 # ckanext-versioned-tiledmap
 
-[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/main.yml)
+[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-versioned-tiledmap/tests.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-versioned-tiledmap/actions/workflows/tests.yml)
 [![Coveralls](https://img.shields.io/coveralls/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap/main?style=flat-square)](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-versioned-tiledmap)
 [![CKAN](https://img.shields.io/badge/ckan-2.9.7-orange.svg?style=flat-square)](https://github.com/ckan/ckan)
 [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg?style=flat-square)](https://www.python.org/)

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/ckanext_versioned_tiledmap.egg-info/requires.txt

@@ -1,6 +1,6 @@
 ckanext-versioned-datastore>=3.7.0
-ckantools>=0.3.0
 cachetools>=4.2.4
+ckantools>=0.4.2
 
 [test]
 mock

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/docs/_scripts/gen_api_pages.py

@@ -1,6 +1,5 @@
 # !/usr/bin/env python
 # encoding: utf-8
-
 """
 Generate the code reference pages and navigation.
 

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ckanext-versioned-tiledmap"
-version = "2.3.2"
+version = "2.3.4"
 description = "A CKAN extension with a map view for versioned-datastore backed resources."
 readme = "README.md"
 requires-python = ">=3.6"
@@ -20,8 +20,8 @@ classifiers = [
 ]
 dependencies = [
     "ckanext-versioned-datastore>=3.7.0",
-    "ckantools>=0.3.0",
-    "cachetools>=4.2.4"
+    "cachetools>=4.2.4",
+    "ckantools>=0.4.2"
 ]
 
 [project.optional-dependencies]
@@ -57,7 +57,7 @@ exclude = ["tests", "docs"]
 
 [tool.commitizen]
 name = "cz_nhm"
-version = "2.3.2"
+version = "2.3.4"
 tag_format = "v$version"
 update_changelog_on_bump = true
 changelog_incremental = true
@@ -66,13 +66,34 @@ version_files = [
     "CITATION.cff:^version"
 ]
 
-[tool.black]
-line-length = 88
-skip_string_normalization = true
+[tool.ruff]
+target-version = "py38"
 
-[tool.pylint]
-max-line-length = 88
-disable = ["C0114", "R0903"]
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "D"
+]
+ignore = [
+    "D100",
+    "D104",
+    "D200",
+    "D202",
+    "D203",
+    "D205",
+    "D206",
+    "D212",
+    "D300",
+    "D401",
+    "E111",
+    "E114",
+    "E117"
+]
 
 [tool.docformatter]
 wrap-summaries = 88

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/tests/test_helpers.py

@@ -1,4 +1,4 @@
-from ckanext.tiledmap.lib.helpers import mustache_wrapper, dwc_field_title
+from ckanext.tiledmap.lib.helpers import dwc_field_title, mustache_wrapper
 
 
 def test_mustache_wrapper():

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/tests/test_route_helpers.py

@@ -1,5 +1,5 @@
 from functools import wraps
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 from ckanext.tiledmap.routes._helpers import extract_q_and_filters
 

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/tests/test_utils.py

@@ -1,5 +1,6 @@
+from unittest.mock import MagicMock, patch
+
 from ckanext.tiledmap.lib.utils import get_resource_datastore_fields
-from unittest.mock import patch, MagicMock
 
 
 def test_get_resource_datastore_fields():

{ckanext_versioned_tiledmap-2.3.2 → ckanext_versioned_tiledmap-2.3.4}/tests/test_validators.py

@@ -1,12 +1,14 @@
+from unittest.mock import MagicMock, patch
+
 import pytest
 from ckan.plugins import toolkit
+
 from ckanext.tiledmap.lib.validators import (
     colour_validator,
     float_01_validator,
     is_datastore_field,
     is_view_id,
 )
-from unittest.mock import MagicMock, patch
 
 
 def test_colour_validator():