goodmap 1.1.7__py3-none-any.whl

goodmap/templates/map.html

@@ -0,0 +1,124 @@
+{% extends "base.html" %}
+
+{% block head_meta %}
+
+<link rel="stylesheet" href="https://unpkg.com/leaflet@1.7.1/dist/leaflet.css"
+      integrity="sha512-xodZBNTC5n17Xt2atTPuE1HxjVMSvLVW9ocqUKLsCC5CXdbqCmblAshOMAS6/keqq/sMZMZ19scR4PsZChSR7A=="
+      crossorigin=""/>
+<link rel="stylesheet" href="https://unpkg.com/leaflet.markercluster@1.5.3/dist/MarkerCluster.css" />
+<link rel="stylesheet" href="https://unpkg.com/leaflet.markercluster@1.5.3/dist/MarkerCluster.Default.css" />
+
+{% endblock %}
+
+
+{% block left_panel %}
+<div id="filter-form"></div>
+{% endblock %}
+
+{% block content %}
+
+    <style>
+        .loading-popup {
+            position: fixed;
+            top: 0;
+            left: 0;
+            width: 100%;
+            height: 100%;
+            display: none;
+            align-items: center;
+            justify-content: center;
+            background-color: rgba(0, 0, 0, 0.5);
+            color: white;
+            font-size: 24px;
+            z-index: 1000;
+        }
+    </style>
+
+<div id="loadingPopup" class="loading-popup">
+  {{ gettext('Loading') }}...
+</div>
+
+<div id="map" class="map h-100 w-100"></div>
+
+<script type="text/javascript">
+
+(function() {
+    // Following code will show a loading popup when an API request is in progress
+    // TODO Fetching /api/data code should be moved to a separate file and included in the base template.
+    //  Code could be refactored to use a more modern approach (e.g. fetch API, async/await) or even moved
+    //  to a goodmap-frontend code. For more check issue #95 (https://github.com/Problematy/goodmap/issues/95)
+
+
+    // Intercept XMLHttpRequest
+    const originalOpen = XMLHttpRequest.prototype.open;
+    const originalSend = XMLHttpRequest.prototype.send;
+
+    XMLHttpRequest.prototype.open = function(method, url) {
+        if (url.includes('/api/data')) {  // Adjust this condition to match your API endpoint
+            this.addEventListener('loadstart', showLoading);
+            this.addEventListener('loadend', hideLoading);
+        }
+        return originalOpen.apply(this, arguments);
+    };
+
+    XMLHttpRequest.prototype.send = function() {
+        return originalSend.apply(this, arguments);
+    };
+
+    // Intercept fetch
+    const originalFetch = window.fetch;
+
+    window.fetch = async function(url, options) {
+        if (url.includes('/api/data')) {  // Adjust this condition to match your API endpoint
+            showLoading();
+        }
+        try {
+            const response = await originalFetch(url, options);
+            return response;
+        } catch (error) {
+            throw error;
+        } finally {
+            if (url.includes('/api/data')) {
+                hideLoading();
+            }
+        }
+    };
+let requestCount = 0;
+
+function showLoading() {
+    requestCount++;
+    if (requestCount === 1) { // Only show on the first request
+        const loadingPopup = document.getElementById('loadingPopup');
+        if (loadingPopup) {
+            loadingPopup.style.display = 'flex';
+        }
+    }
+}
+
+function hideLoading() {
+    requestCount--;
+    if (requestCount === 0) { // Only hide when all requests have completed
+        const loadingPopup = document.getElementById('loadingPopup');
+        if (loadingPopup) {
+            loadingPopup.style.display = 'none';
+        }
+    }
+}
+
+})();
+
+</script>
+<script>
+window.APP_LANG = "{{ current_language }}";
+window.SECONDARY_COLOR = "{{ secondary_color }}";
+window.PRIMARY_COLOR = "{{ primary_color }}";
+
+window.SHOW_SUGGEST_NEW_POINT_BUTTON = {{ feature_flags.SHOW_SUGGEST_NEW_POINT_BUTTON | default(false) | tojson }};
+window.SHOW_SEARCH_BAR = {{ feature_flags.SHOW_SEARCH_BAR | default(false) | tojson }};
+window.USE_LAZY_LOADING = {{ feature_flags.USE_LAZY_LOADING | default(false) | tojson }};
+window.USE_SERVER_SIDE_CLUSTERING = {{ feature_flags.USE_SERVER_SIDE_CLUSTERING | default(false) | tojson }};
+window.SHOW_ACCESSIBILITY_TABLE = {{ feature_flags.SHOW_ACCESSIBILITY_TABLE | default(false) | tojson }};
+window.FEATURE_FLAGS = {{ feature_flags | tojson }};
+</script>
+<script src="{{ goodmap_frontend_lib_url }}"></script>
+{% endblock %}

goodmap-1.1.7.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: goodmap
+Version: 1.1.7
+Summary: Map engine to serve all the people :)
+License-File: LICENSE.md
+Author: Krzysztof Kolodzinski
+Author-email: krzysztof.kolodzinski@problematy.pl
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+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
+Provides-Extra: docs
+Requires-Dist: Babel (>=2.10.3,<3.0.0)
+Requires-Dist: Flask (==3.0.3)
+Requires-Dist: Flask-Babel (>=4.0.0,<5.0.0)
+Requires-Dist: Flask-WTF (>=1.2.1,<2.0.0)
+Requires-Dist: PyYAML (>=6.0,<7.0)
+Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
+Requires-Dist: deprecation (>=2.1.0,<3.0.0)
+Requires-Dist: flask-restx (>=1.3.0,<2.0.0)
+Requires-Dist: google-cloud-storage (>=2.7.0,<3.0.0)
+Requires-Dist: gql (>=3.4.0,<4.0.0)
+Requires-Dist: gunicorn (>=20.1.0,<21.0.0)
+Requires-Dist: humanize (>=4.6.0,<5.0.0)
+Requires-Dist: myst-parser (>=4.0.0,<5.0.0) ; extra == "docs"
+Requires-Dist: numpy (>=2.2.0,<3.0.0)
+Requires-Dist: platzky (>=1.0.0,<2.0.0)
+Requires-Dist: pydantic (>=2.7.1,<3.0.0)
+Requires-Dist: pysupercluster-problematy (>=0.7.8,<0.8.0)
+Requires-Dist: scipy (>=1.15.1,<2.0.0)
+Requires-Dist: sphinx (>=8.0.0,<9.0.0) ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme (>=3.0.0,<4.0.0) ; extra == "docs"
+Requires-Dist: tomli (>=2.0.0,<3.0.0) ; extra == "docs"
+Description-Content-Type: text/markdown
+
+![Github Actions](https://github.com/problematy/goodmap/actions/workflows/release.yml/badge.svg?event=push&branch=main)
+[![Coverage Status](https://coveralls.io/repos/github/Problematy/goodmap/badge.png)](https://coveralls.io/github/Problematy/goodmap)
+
+# Good Map
+
+Map engine to serve all the people ;) 
+
+## Setup
+
+#### 0. Clone the repo
+```
+git clone --recursive
+```
+Remember, everytime you want to pull the newest changes, run:
+```
+git pull
+git submodule update
+```
+because `goodmap` contains a submodule.
+
+#TODO remove all submodule connected instructions after removing platzky submodule (see #157)
+
+#### 1. Use python 3.10
+If you have a different version of Python on your system, install python 3.10 alongside. For that, you can use [`pyenv`](https://github.com/pyenv/pyenv). Follow the [documentation](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation). Useful commands: `pyenv help <command>`, `pyenv install`, `pyenv shell`, `pyenv versions`.
+
+#### 2. Install `poetry` in Python 3.10
+`poetry` can create virtual environments associated with a project. \
+Make sure you are in the Python 3.10 environment and install:
+```
+pip install poetry
+```
+Useful commands: `poetry -h <command>`, `poetry env list`, `poetry env info`.
+
+#### 3. Install dependencies
+```
+poetry install
+```
+
+#### 4. You're ready
+
+When you enter the project directory, you can invoke any commands in your project like this:
+```
+poetry run <command>
+```
+
+## Running App locally
+
+### TL;DR
+If you don't want to go through all the configuration, e.g. you just simply want to test if everything works,
+you can simply run app with test dataset provided in `examples` directory:
+
+> poetry run flask --app 'goodmap.goodmap:create_app(config_path="./examples/e2e_test_config.yml")' run
+
+### Configuration
+
+If you want to serve app with your configuration rename config-template.yml to config.yml and change its contents according to your needs.
+
+Afterwards run it with:
+> poetry run flask --app 'goodmap.goodmap:create_app(config_path="/PATH/TO/YOUR/CONFIG")' --debug run
+
+
+| Option                   | Description                                                                                                                        |
+|--------------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| USE_LAZY_LOADING         | Loads point data only after the user clicks a point. If set to false, point data is loaded together with the initial map.          |
+| FAKE_LOGIN               | If set to true, allows access to the admin panel by simply selecting the role instead of logging in. **DO NOT USE IN PRODUCTION!** |
+| SHOW_ACCESSIBILITY_TABLE | If set as true it shows special view to help with accessing application.                                                           |
+
+## Database
+
+The database is stored in JSON, in the `map` section. For an example database see `examples/e2e_test_data.json`. The first subsection `data` consists of the actual datapoints, representing points on a map.
+
+Datapoints have fields. The next subsections define special types of fields:
+- `obligatory_fields` - here are explicitely stated all the fields that the application assumes are presnt in all datapoints. E.g.
+```
+"position",
+"name",
+"accessible_by"
+```
+TODO: `obligatory_fields` is a new subsection, start using it in the actual application
+- `categories` - fields that can somehow be used in the app, for example by which datapoints can be filtered. Every category has a specified list of allowed values. E.g.
+```
+"accessible_by": ["bikes", "cars", "pedestrians"]
+```
+- `visible_data` - when a datapoint will be rendered as a pin on a map, these fields will be shown in the box when clicking on a pin. E.g.
+```
+"name",
+"type_of_place"
+```
+- `meta-data` - some special data like 
+```
+"uuid"
+```
+
+You can define the fields in all these subsections. Besides these types of fields, there is no restriction on the number of fields a datapoint can have.
+
+## Examples
+
+You can find examples of working configuration and database in `examples/` directory:
+- `e2e_test_config.yml` - Basic configuration example
+- `e2e_test_data.json` - Example database with sample location data
+- `mongo_e2e_test_config.yml` - MongoDB configuration example
+
+
+

goodmap-1.1.7.dist-info/RECORD

@@ -0,0 +1,17 @@
+goodmap/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+goodmap/clustering.py,sha256=ULB-fPNOUDblgpBK4vzuo0o2yqIcvG84F3R6Za2X_l4,2905
+goodmap/config.py,sha256=sseE4sceFB8OBuFsrRpQJvjv0Vg5KFdkzihBX_hbE2c,1313
+goodmap/core.py,sha256=rzMhOIYnR1jxTX6uHQJKIPLYxdUm4_v2d6LrtHtJpHU,1465
+goodmap/core_api.py,sha256=gzFYeek65_4kLET0NPMlSqTz1UGlQl7Dam6lxDtrTIk,19586
+goodmap/data_models/location.py,sha256=brDdaICyYPs8QrWEkRXkUybQS3IJaZGbkDWa6hqhFAg,2008
+goodmap/data_validator.py,sha256=lBmVAPxvSmEOdUGeVYSjUvVVmKfPyq4CWoHfczTtEMM,4090
+goodmap/db.py,sha256=TcqYGbK5yk6S735Si1AzjNqcbB1nsd9pFGOy5qN9Vec,46589
+goodmap/exceptions.py,sha256=jkFAUoc5LHk8iPjxHxbcRp8W6qFCSEA25A8XaSwxwyo,2906
+goodmap/formatter.py,sha256=VlUHcK1HtM_IEU0VE3S5TOkZLVheMdakvUeW2tCKdq0,783
+goodmap/goodmap.py,sha256=q6okPopWBH6jDkKJcGDegebaapHLFUVilJ3p3aKi97k,2960
+goodmap/templates/goodmap-admin.html,sha256=39PJ1drk_xdkyzXgPZZNXYq9gA9oTVeR8hsgeae6E0g,35614
+goodmap/templates/map.html,sha256=aEIL6M7AlBZ34asV5R1syKq9IA1tBZNhiBMA9ovco7I,4105
+goodmap-1.1.7.dist-info/METADATA,sha256=4tjNpCJPcQY-OnSzw2MiWyjGocISorq4oIyZqtJOqX8,5868
+goodmap-1.1.7.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+goodmap-1.1.7.dist-info/licenses/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
+goodmap-1.1.7.dist-info/RECORD,,

goodmap-1.1.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any

goodmap-1.1.7.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 problematy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.