igs-slm 0.1.5b0__tar.gz → 0.1.5b2__tar.gz

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/.gitignore

@@ -163,3 +163,4 @@ test.db
 node_modules
 package-lock.json
 package.json
+CLAUDE.md

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: igs-slm
-Version: 0.1.5b0
+Version: 0.1.5b2
 Summary: IGS Site Log Manager
 Project-URL: Homepage, https://igs-slm.readthedocs.io
 Project-URL: Documentation, https://igs-slm.readthedocs.io
@@ -64,6 +64,10 @@ Requires-Dist: python-dateutil<3.0.0,>=2.8.2
 Requires-Dist: requests<3.0.0,>=2.32.4
 Requires-Dist: rich<14.0.0,>=13.7.1
 Requires-Dist: tqdm<5.0.0,>=4.64.1
+Provides-Extra: debug
+Requires-Dist: django-debug-toolbar<5.0.0,>=4.1.0; extra == 'debug'
+Requires-Dist: django-extensions<4.0.0,>=3.1.5; extra == 'debug'
+Requires-Dist: ipdb<1.0.0,>=0.13.13; extra == 'debug'
 Provides-Extra: gunicorn
 Requires-Dist: gunicorn>=22.0.0; extra == 'gunicorn'
 Description-Content-Type: text/markdown

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/SECURITY.md

@@ -22,8 +22,10 @@ The SLM depends on a large stack of upstream software. Not just Django and Pytho
 
 If we exempt the vulnerability the reason will be noted in the [policy file](https://github.com/International-GNSS-Service/SLM/blob/main/.safety-policy.yml).
 
+## Publishing Releases
+
+All releases will have verified tag on github. As of 0.1.5b0 we use [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) to issue all releases.
 
 ## Reporting a Vulnerability
 
-If you think you have found a vulnerability, and even if you are not sure, please report it to us in private by going to Security -> Advisories -> New Draft Security Advisory or alternatively, email us at cb@igs.org
-We will review it and get back to you. Please refrain from public discussions of the issue.
+If you think you have found a vulnerability, and even if you are not sure, please [report it to us in private](https://github.com/International-GNSS-Service/SLM/security/advisories/new) or alternatively, email us at cb@igs.org. We will review it and get back to you. Please refrain from public discussions of the issue.

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/doc/source/changelog.rst

@@ -6,8 +6,21 @@
 Change Log
 ==========
 
-v0.1.5b (2024-07-15)
-====================
+v0.1.5b2 (2025-07-15)
+=====================
+
+* Beta Bug Fix
+* Added `Add debug dependency group <https://github.com/International-GNSS-Service/SLM/issues/155>`_
+* Fixed `WSGI_APPLICATION default is wrong <https://github.com/International-GNSS-Service/SLM/issues/154>`_
+
+v0.1.5b1 (2025-07-15)
+=====================
+
+* Beta Bug Fix
+* Fixed `SLM_INCLUDE url inclusion is not working to spec <https://github.com/International-GNSS-Service/SLM/issues/152>`_
+
+v0.1.5b0 (2025-07-15)
+=====================
 
 * Beta Increment
 * Implemented `Allow environment variables to override specific default settings. <https://github.com/International-GNSS-Service/SLM/issues/150>`_

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/doc/source/configuration.rst

@@ -1,5 +1,6 @@
 .. include:: refs.rst
 
+.. _configuration:
 
 =============
 Configuration
@@ -518,7 +519,7 @@ We provide a more reasonable default than Django_'s :setting:`django:DEFAULT_FRO
 -----------------------
 .. setting:: WSGI_APPLICATION
 
-Default: ``slm.wsgi``
+Default: ``slm.wsgi.application``
 
 We set a default for :setting:`django:WSGI_APPLICATION` that works if *either*:
 

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/doc/source/index.rst

@@ -30,7 +30,8 @@ This documentation speaks to multiple audiences:
 
 * **Developers** will want to refer to the :ref:`installation`, :ref:`architecture`,
   :ref:`commands` and :ref:`reference` sections.
-* **System administrators** may be interested in :ref:`operations` and :ref:`commands`.
+* **System administrators** may be interested in :ref:`configuration`, :ref:`upgrading` and
+  :ref:`commands`.
 * **Users** and **network coordinators** will be interested in the :ref:`user_manual`.
 * **Developers** wishing to work with SLM managed data will be interested in the :ref:`api`.
 * **Everyone**, but particularly **program managers** will want to take a look at the
@@ -47,9 +48,7 @@ map is on the projects_ page.
 
 Contributions_ from the community are encouraged!
 
-.. APIs
-.. manual/index
-.. operations/index
+
 
 .. toctree::
    :maxdepth: 2
@@ -60,8 +59,10 @@ Contributions_ from the community are encouraged!
    upgrading
    configuration
    architecture/index
+   manual/index
    commands
    dependencies
+   APIs
    reference/index
    changelog
 

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/doc/source/installation.rst

@@ -35,12 +35,19 @@ Hereafter, we will use the following terminology to describe these deployments:
 Manual Installation
 ===================
 
-The SLM is both a :doc:`Django app <django:ref/applications>` and a fully deployable website. Most
-users of the SLM will want to customize certain aspects of it (things like adding
-:pypi:`django-ldap` or :doc:`two-factor authentication <django-allauth:mfa/index>`). To facilitate
-that we will use the bundled command slm-startproject_ to generate a scaffold to build off of (not
-unlike Django's :django-admin:`startproject`). But first we must install some dependencies.
-
+The SLM is both a :doc:`Django app <django:ref/applications>` and a fully deployable website. Many
+users of the SLM will want to customize it significantly (things like adding
+:pypi:`django-ldap` or :doc:`two-factor authentication <django-allauth:mfa/index>`). It can also
+be deployed out of the box with a :ref:`minimal configuration <configuration>`. We recommend trying
+a minimal development set up first to familiarize yourself with the software and identify any data
+importing pain points. The following guide includes instructions for running the SLM out of the
+box and for generating a scaffold to customize it. We will first work through a
+:ref:`local develop <slm-startproject>` installation and then we cover
+:ref:`deployment to a production server <deploy>`.
+
+To facilitate customization we provide a bundled command slm-startproject_ to generate a scaffold to
+build off of (not unlike Django's :django-admin:`startproject`). But first we must install some
+dependencies.
 
 Dependencies
 ############
@@ -132,6 +139,8 @@ Platform specific Installation guidance.
 Start Project
 #############
 
+**If you are not customizing the SLM, skip ahead to step 2.**
+
 To get up and running quickly with your customized SLM deployment we bundle a command called
 slm-startproject_ that will scaffold out a directory structure and settings files for you to start
 working with. Before running slm-startproject_ you will need to have installed all of GeoDjango_'s
@@ -149,7 +158,7 @@ itself yet though.
 
     .. code:: bash
 
-      ?> uvx slm-startproject --help
+      ?> uvx --from igs-slm --prerelease slm-startproject --help
 
   .. tab:: pip
 
@@ -162,8 +171,8 @@ itself yet though.
 
   .. tab:: github
 
-    You also have the option of working with our development version from github, but unless you have
-    a compelling reason to do so you should use the release on pypi.
+    You also have the option of working with our development version from github, but unless you
+    have a compelling reason to do so you should use the release on pypi.
 
     .. code:: bash
 
@@ -256,16 +265,57 @@ the first question you can just hit enter to accept the defaults:
 (2) Create environment & database
 ---------------------------------
 
-* Use either psql_ or pgAdmin_ to create the database that slm-startproject_ instructs you to.
-  In our example this database would be named ``network``.
+.. tabs::
+
+  .. tab:: Basic Install
+
+    * Use either psql_ or pgAdmin_ to create a database called ``slm``.
+
+    * We recommend creating a local development :mod:`python virtual environment <venv>`, but you
+      may also use any python on your system that meets the :pypi:`igs-slm` minimum python
+      requirement.
+
+    * You will need to set a few environment variables and create an environment variable file so
+      the SLM knows some basic things about itself.
+
+    In your local development directory:
+
+    .. code-block:: bash
+
+      ?> python -m venv .venv
+      ?> source .venv/bin/activate
+      (.venv) ?> export SLM_ENV=`pwd`/.env
+      (.venv) ?> touch .env
+      (.venv) ?> pip install "igs-slm[debug]"
 
-* Use uv to install the virtual environment then activate it.
+    Add a minimal configuraton to the .env file. It may look something like this. You may also
+    refer to the :ref:`configuration` page for all of the available settings. The most important
+    settings are :setting:`SLM_ENV`, :setting:`BASE_DIR`:
 
     .. code-block:: bash
 
-      ?> uv sync --all-extras
+      DEBUG=True
+      BASE_DIR=./
+      SLM_ORG_NAME="ORG"
+      SLM_SITE_NAME="localhost"
+      # you may have to set these paths if your postgis libraries
+      # are in non-standard locations
+      # GEOS_LIBRARY_PATH=/path/to/libgeos_c.dylib
+      # GDAL_LIBRARY_PATH=/path/to/libgdal.dylib
 
 
+  .. tab:: Custom Install
+
+    * Use either psql_ or pgAdmin_ to create the database that slm-startproject_ instructs you to.
+      In our example this database would be named ``network``.
+
+    * Use uv to install the virtual environment then activate it.
+
+        .. code-block:: bash
+
+          ?> cd ./network
+          ?> uv sync --all-extras
+
 .. _import_sitelogs:
 
 (3) Import Existing Logs and Deploy
@@ -276,11 +326,23 @@ existing logs to import you'll probably just want to run :django-admin:`routine
 Otherwise gather your logs into a single directory or tar file and run the
 :django-admin:`routine install` routine:
 
-  .. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
+
+    .. code-block:: bash
+
+      (.venv) ?> slm routine install
 
-    ?> <slm> routine install
+  .. tab:: Custom Install
 
-**<slm> is the name of your management script. In our example it would be called 'network'.**
+    .. code-block:: bash
+
+      ?> uv run network routine install
+
+You will be prompted to create a superuser account and also for a file path or directory containing
+site logs you wish to import. After the import is finished an html log of the import process will
+open.
 
 The data import will both generate logs and record import errors and warnings as alerts and
 validation flags in the database so you can manually go through the web interface and correct any
@@ -291,24 +353,39 @@ errors.
 
 You should now be able to start up the development server and see data in your SLM instance.
 
-  .. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
 
-    ?> <slm> runserver
-    Performing system checks...
+    .. code-block:: bash
+
+      (.venv) ?> <slm> runserver
+      Performing system checks...
+
+      System check identified no issues (1 silenced).
+      Django version 4.2.23, using settings 'slm.settings.root'
+      Starting development server at http://127.0.0.1:8000/
+      Quit the server with CONTROL-C.
+
+  .. tab:: Custom Install
+
+    .. code-block:: bash
 
-    System check identified no issues (1 silenced).
-    Django version 4.2.14, using settings 'sites.<slm>.develop'
-    Starting development server at http://127.0.0.1:8000/
-    Quit the server with CONTROL-C.
+      ?> uv run network runserver
+      Performing system checks...
+
+      System check identified no issues (1 silenced).
+      Django version 4.2.23, using settings 'sites.network.develop'
+      Starting development server at http://127.0.0.1:8000/
+      Quit the server with CONTROL-C.
 
 In addition to the front end interface where site logs are edited, moderated and published. We use
 the `Django admin for a more direct access to system data <http://127.0.0.1:8000/admin>`_. This is
 where we control permissions and make site adjustments. You may also add users and agencies and set
 their permissions through the admin.
 
-.. tip::
 
-  Refer to :ref:`operations` for advice on production deployments.
+.. _deploy:
 
 Deploy
 ######
@@ -537,11 +614,20 @@ will migrate the database and bundle all static files:
 
   (slm_venv) ?> network routine deploy
 
+
+.. tip::
+
+  Refer to :ref:`upgrading` for advice on updating the SLM.
+
 .. _containerization:
 
 Containerization
 ================
 
+.. todo::
+
+    Instructions for running our containers..
+
 
 .. _fast_hosting:
 
@@ -549,4 +635,5 @@ Fast Hosting
 ============
 
 .. todo::
-       Instructions for quickly deploying to a hosting service..
+
+    Instructions for quickly deploying to a hosting service..

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/doc/source/upgrading.rst

@@ -1,5 +1,6 @@
 .. include:: refs.rst
 
+.. _upgrading:
 
 =========
 Upgrading

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "igs-slm"
-version = "0.1.5b0"
+version = "0.1.5b2"
 description = "IGS Site Log Manager"
 requires-python = ">=3.8,<4.0"
 authors = [
@@ -85,6 +85,11 @@ dependencies = [
 
 [project.optional-dependencies]
 gunicorn = ["gunicorn>=22.0.0"]
+debug = [
+    "ipdb>=0.13.13,<1.0.0",
+    "django-debug-toolbar>=4.1.0,<5.0.0",
+    "django-extensions>=3.1.5,<4.0.0",
+]
 
 
 [build-system]

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/__init__.py

@@ -15,7 +15,7 @@ r"""
 
 """
 
-VERSION = (0, 1, "5b0")
+VERSION = (0, 1, "5b2")
 
 __title__ = "IGS/Site Log Manager"
 __version__ = ".".join(str(i) for i in VERSION)

igs_slm-0.1.5b2/src/slm/bin/templates/{{ project_dir }}/src/sites/{{ site }}/urls.py

@@ -0,0 +1,15 @@
+"""
+You can make direct modifications to the URLs built by the slm here if needed.
+
+Your extension app will already be included at the root path because it sets:
+
+    SLM_INCLUDE = True.
+"""
+
+from slm.settings.urls import urlpatterns
+from django.urls import path, include
+
+
+urlpatterns.extend([
+    # add other app URLs here
+])

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/bin/templates/{{ project_dir }}/src/{{ extension_app }}/urls.py

@@ -6,5 +6,6 @@ from django.urls import path
 
 app_name = "{{ extension_app }}"
 
+SLM_INCLUDE = True
 
 urlpatterns = []

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/map/templates/slm/map.html

@@ -366,7 +366,7 @@
         //slm.addColumnFiltering( stationTable );
     </script>
     {% else %}
-    {% trans "To enable maps, create a MapBox account and configure the api key in the admin:" %} <a href="https://mapbox.com">mapbox.com</a>
+    {% trans "To enable maps, create a MapBox account and " %}<a href="{% url 'admin:slm_map_mapsettings_change' 1 %}">{% trans "configure the api key in the admin:" %}</a> <a href="https://mapbox.com">mapbox.com</a>
     {% endif %}
 </div>
 {% endblock %}

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/settings/root.py

@@ -242,5 +242,5 @@ set_default(
 )
 
 WSGI_APPLICATION = env(
-    "WSGI_APPLICATION", default=get_setting("WSGI_APPLICATION", "slm.wsgi")
+    "WSGI_APPLICATION", default=get_setting("WSGI_APPLICATION", "slm.wsgi.application")
 )

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/settings/slm.py

@@ -178,13 +178,6 @@ set_default(
     },
 )
 
-# slm provides an implementation of urls.py that will load this list into
-# url patterns. This should be a list of 2-tuples where the first tuple is the
-# path stem mount point for the included apps' URLs and the second element is
-# the string that will be passed to django.urls.include
-SLM_URL_MOUNTS = []
-
-
 # control the domain used to generate absolute links to the SLM log document
 # attachments including images and files. Any standalone artifacts produced by
 # the slm that include links to files served by the SLM will use this domain

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/settings/urls.py

@@ -38,16 +38,6 @@ APIS dictionary. For example the slm.map app extends the public API like so:
         }
     }
 
-Other third party apps may be included at customizable mount points by
-providing a settings.SLM_URL_MOUNTS list. For example to include your app at
-the myapp path you might do this:
-
-.. code-block: python
-
-    SLM_URL_MOUNTS = [
-        ('myapp/', 'myapp.urls')
-    ]
-
 """
 
 from importlib import import_module
@@ -80,7 +70,11 @@ def bring_in_urls(urlpatterns):
 
     for app in reversed(settings.INSTALLED_APPS):
         try:
-            url_module = import_module(f"{app}.urls")
+            url_module_str = f"{app}.urls"
+            url_module = import_module(url_module_str)
+            slm_include = getattr(url_module, "SLM_INCLUDE", False)
+            if not slm_include:
+                continue
             api = getattr(url_module, "APIS", None)
             if api:
                 for api, endpoints in api.items():
@@ -95,6 +89,7 @@ def bring_in_urls(urlpatterns):
                                 endpoint[0] if len(endpoint) < 3 else endpoint[2]
                             ),
                         )
+            urlpatterns.insert(0, path("", include(url_module_str)))
 
         except ImportError:
             if app in {"slm", "slm.map", "network_map", "igs_ext"}:

{igs_slm-0.1.5b0 → igs_slm-0.1.5b2}/src/slm/static/slm/js/enums.js

@@ -201,12 +201,12 @@ class SiteFileUploadStatus {
 }
 class SiteLogFormat {
 	
-	static LEGACY = new SiteLogFormat(1, "LEGACY", "Legacy (ASCII)", "text/plain", "bi bi-file-text", "log", ["text", "txt", "legacy"]);
-	static GEODESY_ML = new SiteLogFormat(2, "GEODESY_ML", "GeodesyML", "application/xml", "bi bi-filetype-xml", "xml", ["xml"]);
-	static JSON = new SiteLogFormat(3, "JSON", "JSON", "application/json", "bi bi-filetype-json", "json", ["json", "js"]);
-	static ASCII_9CHAR = new SiteLogFormat(4, "ASCII_9CHAR", "ASCII (9-Char)", "text/plain", "bi bi-file-text", "log", ["text", "txt", "9char"]);
+	static LEGACY = new SiteLogFormat(1, "LEGACY", "Legacy (ASCII)", "text/plain", "bi bi-file-text", "log", ["text", "txt", "legacy"], ["txt", "sitelog"]);
+	static GEODESY_ML = new SiteLogFormat(2, "GEODESY_ML", "GeodesyML", "application/xml", "bi bi-filetype-xml", "xml", ["xml"], ["gml"]);
+	static JSON = new SiteLogFormat(3, "JSON", "JSON", "application/json", "bi bi-filetype-json", "json", ["json", "js"], ["js"]);
+	static ASCII_9CHAR = new SiteLogFormat(4, "ASCII_9CHAR", "ASCII (9-Char)", "text/plain", "bi bi-file-text", "log", ["text", "txt", "9char"], ["txt", "sitelog"]);
 	
-	constructor (value, name, label, mimetype, icon, ext, alts) {
+	constructor (value, name, label, mimetype, icon, ext, alts, alt_exts) {
 		this.value = value;
 		this.name = name;
 		this.label = label;
@@ -214,6 +214,7 @@ class SiteLogFormat {
 		this.icon = icon;
 		this.ext = ext;
 		this.alts = alts;
+		this.alt_exts = alt_exts;
 	}
 	
 	static ciCompare(a, b) {