yafowil.widget.location 2.0.0__tar.gz

yafowil_widget_location-2.0.0/.gitignore

@@ -0,0 +1,20 @@
+*.egg-info
+*.pyc
+*.pyo
+/.coverage
+/.mxmake/
+/build
+/constraints-mxdev.txt
+/coverage/
+/dist/
+/htmlcov/
+/js/karma/
+/node_modules/
+/package-lock.json
+/pnpm-lock.yaml
+/py2/
+/py3/
+/pypy3/
+/requirements-mxdev.txt
+/sources/
+/venv/

yafowil_widget_location-2.0.0/CHANGES.rst

@@ -0,0 +1,106 @@
+Changes
+=======
+
+2.0.0 (2026-02-03)
+------------------
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
+  [rnix]
+
+- Introduce ``disable_interaction`` widget property and ``location_display_renderer``.
+  [lenadax]
+
+- Update jQuery to version ``4.0.0-beta.2``.
+  [lenadax]
+
+- Use Bootstrap icons as custom Leaflet markers.
+  [lenadax]
+
+- Implement dark theme for ``Bootstrap5`` dark theme mode using css filters.
+  [lenadax]
+
+- Use rollup for bundling scss. Use ``make rollup`` to compile js and scss.
+  [lenadax]
+
+- Use ``webtestrunner`` instead of ``karma`` for js tests. Use ``make wtr`` to run tests.
+  [lenadax]
+
+- Use ``pnpm`` as package manager.
+  [lenadax]
+
+- Use default ``zoom`` if ``extract_zoom`` is ``True`` but no zoom given on
+  request.
+  [rnix]
+
+- Prevent initialize if widget is part of array template.
+  [lenadax]
+
+- Extend JS by ``location_on_array_add`` and ``register_array_subscribers``
+  functions to enable usage in ``yafowil.widget.array``.
+  [lenadax]
+
+- Rewrite JavaScript using ES6.
+  [rnix]
+
+- Introduce ``show_lat_lon`` widget property. If True, latitude and longtude
+  additionally can be entered manually in inpuf fields.
+  [rnix]
+
+- Consider ``emptyvalue`` at extraction time.
+  [rnix]
+
+- Introdude ``factory`` widget property. Defines a factory which is used to
+  instance ectraction value.
+  [rnix]
+
+- Introduce ``extract_zoom`` widget property. Defines whether to include
+  zoom level on extracted value.
+  [rnix]
+
+- Create Bootstrap5 widget version.
+  [lenadax]
+
+- Rewrite Javascript with ES6 classes.
+  [rnix]
+
+- Update leaflet to 1.7.1 and leaflet-geosearch to 3.5.0.
+  [rnix]
+
+**Breaking changes**
+
+- Empty extration value is ``None`` instead of empty dictionary.
+  [rnix]
+
+
+1.3 (2025-11-03)
+----------------
+
+- Pin upper versions of dependencies.
+  [lenadax]
+
+
+1.2 (2018-07-16)
+----------------
+
+- Python 3 compatibility.
+  [rnix]
+
+- Convert doctests to unittests.
+  [rnix]
+
+
+1.1 (2017-03-01)
+----------------
+
+- Use ``yafowil.utils.entry_point`` decorator.
+  [rnix, 2016-06-28]
+
+- Raise ``ValueError`` in ``location_extractor`` if malformed request is
+  received.
+  [rnix]
+
+1.0 (2015-01-23)
+----------------
+
+- Make it work.
+  [rnix]

yafowil_widget_location-2.0.0/LICENSE.rst

@@ -0,0 +1,27 @@
+License
+=======
+
+Copyright (c) 2014-2021, BlueDynamics Alliance, Austria, Germany, Switzerland
+Copyright (c) 2021-2025, Yafowil Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

yafowil_widget_location-2.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: yafowil.widget.location
+Version: 2.0.0
+Summary: Location picker widget for YAFOWIL
+Author-email: Yafowil Contributors <dev@conestack.org>
+License: Simplified BSD
+License-File: LICENSE.rst
+Classifier: Environment :: Web Environment
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Dist: yafowil>3.99
+Provides-Extra: test
+Requires-Dist: lxml; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/yafowil.widget.location.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.location
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/yafowil.widget.location.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.location
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_py.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_py.yaml
+    :alt: Test yafowil.widget.location Python
+
+.. image:: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_js.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_js.yaml
+    :alt: Test yafowil.widget.location JS
+
+This is the location widget for `yafowil <http://pypi.python.org/pypi/yafowil>`_,
+based on `Leaflet <http://leafletjs.org>`_
+
+- `Documentation <http://docs.yafowil.info/en/latest/blueprints.html#location>`_
+
+- `DEMO - see it Live <http://demo.yafowil.info/++widget++yafowil.widget.location/index.html>`_
+
+- This widget uses `leaflet <https://leafletjs.com/>`_ (1.7.1) and
+  `leaflet-geosearch <https://smeijer.github.io/leaflet-geosearch>`_ (3.5.0).
+
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.location>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+
+- Georg Bernhard
+
+- Lena Daxenbichler

yafowil_widget_location-2.0.0/README.rst

@@ -0,0 +1,44 @@
+.. image:: https://img.shields.io/pypi/v/yafowil.widget.location.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.location
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/yafowil.widget.location.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.location
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_py.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_py.yaml
+    :alt: Test yafowil.widget.location Python
+
+.. image:: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_js.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.location/actions/workflows/test_js.yaml
+    :alt: Test yafowil.widget.location JS
+
+This is the location widget for `yafowil <http://pypi.python.org/pypi/yafowil>`_,
+based on `Leaflet <http://leafletjs.org>`_
+
+- `Documentation <http://docs.yafowil.info/en/latest/blueprints.html#location>`_
+
+- `DEMO - see it Live <http://demo.yafowil.info/++widget++yafowil.widget.location/index.html>`_
+
+- This widget uses `leaflet <https://leafletjs.com/>`_ (1.7.1) and
+  `leaflet-geosearch <https://smeijer.github.io/leaflet-geosearch>`_ (3.5.0).
+
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.location>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+
+- Georg Bernhard
+
+- Lena Daxenbichler

yafowil_widget_location-2.0.0/TODO.rst

@@ -0,0 +1,4 @@
+TODO
+====
+
+- Refactor server side to render widget as compound.

yafowil_widget_location-2.0.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yafowil.widget.location"
+version = "2.0.0"
+description = "Location picker widget for YAFOWIL"
+readme = "README.rst"
+license = {text = "Simplified BSD"}
+authors = [{name = "Yafowil Contributors", email = "dev@conestack.org"}]
+classifiers = [
+    "Environment :: Web Environment",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "License :: OSI Approved :: BSD License",
+]
+dependencies = [
+    "yafowil>3.99",
+]
+
+[project.optional-dependencies]
+test = [
+    "lxml",
+    "pytest",
+]
+
+[project.entry-points."yafowil.plugin"]
+register = "yafowil.widget.location:register"
+example = "yafowil.widget.location.example:get_example"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/x-rst"
+fragments = [
+    {path = "README.rst"},
+    {text = "\n\n"},
+    {path = "CHANGES.rst"},
+    {text = "\n\n"},
+    {path = "LICENSE.rst"},
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/.github/",
+    "/js/",
+    "/Makefile",
+    "/mx.ini",
+    "/mxmake.yaml",
+    "/package.json",
+    "/pnpm-lock.yaml",
+    "/scss",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yafowil"]
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+addopts = ["--import-mode=importlib"]
+pythonpath = "src"
+
+[tool.zest-releaser]
+create-wheel = true

yafowil_widget_location-2.0.0/src/yafowil/widget/location/__init__.py

@@ -0,0 +1,198 @@
+from yafowil.base import factory
+from yafowil.utils import entry_point
+import os
+import webresource as wr
+
+
+resources_dir = os.path.join(os.path.dirname(__file__), 'resources')
+
+
+##############################################################################
+# Leaflet
+##############################################################################
+
+# webresource ################################################################
+
+leaflet_js = wr.ScriptResource(
+    name='leaflet-js',
+    directory=os.path.join(resources_dir, 'leaflet'),
+    path='yafowil-location/leaflet',
+    resource='leaflet-src.js',
+    compressed='leaflet.js'
+)
+leaflet_css = wr.StyleResource(
+    name='leaflet-css',
+    directory=os.path.join(resources_dir, 'leaflet'),
+    path='yafowil-location/leaflet',
+    resource='leaflet.css'
+)
+leaflet_geosearch_js = wr.ScriptResource(
+    name='leaflet-geosearch-js',
+    depends='leaflet-js',
+    directory=os.path.join(resources_dir, 'leaflet-geosearch'),
+    path='yafowil-location/leaflet-geosearch',
+    resource='geosearch.umd.js'
+)
+leaflet_geosearch_css = wr.StyleResource(
+    name='leaflet-geosearch-css',
+    depends='leaflet-css',
+    directory=os.path.join(resources_dir, 'leaflet-geosearch'),
+    path='yafowil-location/leaflet-geosearch',
+    resource='geosearch.css'
+)
+
+##############################################################################
+# Default
+##############################################################################
+
+# webresource ################################################################
+
+resources = wr.ResourceGroup(
+    name='yafowil.widget.location',
+    directory=resources_dir,
+    path='yafowil-location'
+)
+resources.add(leaflet_js)
+resources.add(leaflet_css)
+resources.add(leaflet_geosearch_js)
+resources.add(leaflet_geosearch_css)
+resources.add(wr.ScriptResource(
+    name='yafowil-location-js',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-location/default',
+    depends=['jquery-js', 'leaflet-geosearch-js'],
+    resource='widget.js',
+    compressed='widget.min.js'
+))
+resources.add(wr.StyleResource(
+    name='yafowil-location-css',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-location/default',
+    depends='leaflet-geosearch-css',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+js = [{
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet/leaflet.js',
+    'order': 20,
+}, {
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet-geosearch/geosearch.umd.js',
+    'order': 21,
+}, {
+    'group': 'yafowil.widget.location.common',
+    'resource': 'default/widget.js',
+    'order': 23,
+}]
+css = [{
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet/leaflet.css',
+    'order': 20,
+}, {
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet-geosearch/geosearch.css',
+    'order': 21,
+}, {
+    'group': 'yafowil.widget.location.common',
+    'resource': 'default/widget.min.css',
+    'order': 22,
+}]
+
+
+##############################################################################
+# Bootstrap 5
+##############################################################################
+
+# webresource ################################################################
+
+bootstrap5_resources = wr.ResourceGroup(
+    name='yafowil.widget.location',
+    directory=resources_dir,
+    path='yafowil-location'
+)
+bootstrap5_resources.add(leaflet_js)
+bootstrap5_resources.add(leaflet_css)
+bootstrap5_resources.add(leaflet_geosearch_js)
+bootstrap5_resources.add(leaflet_geosearch_css)
+bootstrap5_resources.add(wr.ScriptResource(
+    name='yafowil-location-js',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-location/bootstrap5',
+    depends=['jquery-js', 'leaflet-geosearch-js'],
+    resource='widget.js',
+    compressed='widget.min.js'
+))
+bootstrap5_resources.add(wr.StyleResource(
+    name='yafowil-location-css',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-location/bootstrap5',
+    depends='leaflet-geosearch-css',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+bootstrap5_js = [{
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet/leaflet.js',
+    'order': 20,
+}, {
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet-geosearch/geosearch.umd.js',
+    'order': 21,
+}, {
+    'group': 'yafowil.widget.location.common',
+    'resource': 'bootstrap5/widget.js',
+    'order': 23,
+}]
+bootstrap5_css = [{
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet/leaflet.css',
+    'order': 20,
+}, {
+    'group': 'yafowil.widget.location.dependencies',
+    'resource': 'leaflet-geosearch/geosearch.css',
+    'order': 21,
+}, {
+    'group': 'yafowil.widget.location.common',
+    'resource': 'bootstrap5/widget.min.css',
+    'order': 22,
+}]
+
+##############################################################################
+# Registration
+##############################################################################
+
+@entry_point(order=10)
+def register():
+    from yafowil.widget.location import widget  # noqa
+
+    widget_name = 'yafowil.widget.location'
+
+    # Default
+    factory.register_theme(
+        'default',
+        widget_name,
+        resources_dir,
+        js=js,
+        css=css
+    )
+    factory.register_resources('default', widget_name, resources)
+
+    # Bootstrap 5
+    factory.register_theme(
+        ['bootstrap5'],
+        widget_name,
+        resources_dir,
+        js=bootstrap5_js,
+        css=bootstrap5_css
+    )
+
+    factory.register_resources(
+        ['bootstrap5'],
+        widget_name,
+        bootstrap5_resources
+    )

yafowil_widget_location-2.0.0/src/yafowil/widget/location/example.py

@@ -0,0 +1,135 @@
+from yafowil.base import factory
+
+
+DOC_LOCATION = """
+Location
+--------
+
+Location picker widget.
+
+.. code-block:: python
+
+    location = factory('#field:location', props={
+        'label': 'Location',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required',
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    })
+"""
+
+
+def location_example():
+    form = factory('fieldset', name='yafowil.widget.location.location')
+    form['location'] = factory('#field:location', props={
+        'label': 'Location',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required',
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    })
+    return {
+        'widget': form,
+        'doc': DOC_LOCATION,
+        'title': 'Location',
+    }
+
+
+DOC_LOCATION_WITH_PRESET_VALUE = """
+Location with preset value
+--------------------------
+
+Location picker widget with preset value.
+
+.. code-block:: python
+
+    value = {
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    }
+    location = factory('#field:location', value=value, props={
+        'label': 'Location',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required',
+    })
+"""
+
+
+def location_with_preset_value_example():
+    name = 'yafowil.widget.location.location_with_preset_value'
+    form = factory('fieldset', name=name)
+    value = {
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    }
+    form['location'] = factory('#field:location', value=value, props={
+        'label': 'Location',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_LOCATION_WITH_PRESET_VALUE,
+        'title': 'Location with preset value',
+    }
+
+
+DOC_LOCATION_DISPLAY = """
+Display Mode / Disabled Mode
+----------------------------
+
+The ``disable_interaction`` widget attribute prevents interaction with the widget.
+The widget's display mode automatically sets ``disable_interaction`` to True.
+
+Zooming and panning is still supported, but Markers cannot be added, edited or removed.
+
+The wrapper div can receive additional classes via the ``display_class``
+widget attribute.
+
+.. code-block:: python
+
+    value = {
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    }
+    location = factory('#field:location', value=value, mode='display', props={
+        'label': 'Location in Display Mode',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required',
+        # 'disable_interaction': True, # manually disable interaction
+        # 'display_class': 'my-additional-class'
+    })
+"""
+
+
+def location_display():
+    name = 'yafowil.widget.location.display'
+    form = factory('fieldset', name=name)
+    value = {
+        'lat': 47.2667,
+        'lon': 11.3833,
+        'zoom': 14,
+    }
+    form['location'] = factory('#field:location', value=value, mode='display', props={
+        'label': 'Location in Display Mode',
+        'help': 'Search and pick a location on the map',
+        'required': 'Location is required'
+    })
+    return {
+        'widget': form,
+        'doc': DOC_LOCATION_DISPLAY,
+        'title': 'Display Mode',
+    }
+
+
+def get_example():
+    return [
+        location_example(),
+        location_with_preset_value_example(),
+        location_display()
+    ]