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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: igs-slm
-Version: 0.1.5b2
+Version: 0.1.5b3
 Summary: IGS Site Log Manager
 Project-URL: Homepage, https://igs-slm.readthedocs.io
 Project-URL: Documentation, https://igs-slm.readthedocs.io

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

@@ -6,6 +6,13 @@
 Change Log
 ==========
 
+v0.1.5b3 (2025-07-25)
+=====================
+
+* Fixed `Provide SLM IGS station naming validation toggle. <https://github.com/International-GNSS-Service/SLM/issues/153>`_
+* Fixed `Sometimes the javascript diffing/site log error renderer inserts extra newlines. <https://github.com/International-GNSS-Service/SLM/issues/151>`_
+
+
 v0.1.5b2 (2025-07-15)
 =====================
 

{igs_slm-0.1.5b2 → igs_slm-0.1.5b3}/doc/source/conf.py

@@ -13,6 +13,7 @@ from sphinx.ext.autodoc import between
 import warnings
 import os
 import django
+from django.utils.version import get_docs_version
 import re
 
 sys.path.append(str(Path(__file__).parent.parent.parent / "src"))
@@ -20,6 +21,7 @@ sys.path.append(str(Path(__file__).parent.parent.parent))
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
 django.setup()
 
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -106,13 +108,22 @@ django_show_db_tables = True                # Boolean, default: False
 # Add abstract database tables names (only takes effect if django_show_db_tables is True)
 django_show_db_tables_abstract = True       # Boolean, default: False
 
+autodoc_default_options = {
+    'show-inheritance': True,
+    # Add other autodoc options here if desired, e.g.:
+    # 'members': True,
+    # 'inherited-members': True,
+}
+# In your Sphinx conf.py
+autodoc_typehints = "description"
+autodoc_typehints_format = "short"
+autodoc_class_signature = "separated"
 autodoc_member_order = 'bysource'
 
-# TODO - ALWAYS POINT THE DJANGO DOCS AT OUR CURRENT DJANGO VERSION, NOT STABLE
 intersphinx_mapping = {
     "django": (
-        "https://docs.djangoproject.com/en/4.2",
-        "https://docs.djangoproject.com/en/4.2/_objects/",
+        f"https://docs.djangoproject.com/en/{get_docs_version()}/",
+        f"https://docs.djangoproject.com/en/{get_docs_version()}/_objects/",
     ),
     "click": ("https://click.palletsprojects.com/en/stable", None),
     "rich": ("https://rich.readthedocs.io/en/stable", None),
@@ -139,6 +150,7 @@ html_css_files = [
     'https://cdnjs.cloudflare.com/ajax/libs/bootstrap-icons/1.11.3/font/bootstrap-icons.min.css',
 ]
 
+
 def color_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
     """Role that creates a color box with the hex color."""
     from docutils import nodes
@@ -156,6 +168,7 @@ def color_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
     node = nodes.raw('', html, format='html')
     return [node], []
 
+
 def css_icon(name, rawtext, text, lineno, inliner, options={}, content=[]):
     """Role that creates a color box with the hex color."""
     from docutils import nodes
@@ -168,6 +181,7 @@ def css_icon(name, rawtext, text, lineno, inliner, options={}, content=[]):
     node = nodes.raw('', html, format='html')
     return [node], []
 
+
 def setup(app):
     # Register a sphinx.ext.autodoc.between listener to ignore everything
     # between lines that contain the word IGNORE

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

@@ -221,6 +221,9 @@ The following settings may be overridden by environment variables:
    * - :setting:`SLM_DEBUG_TOOLBAR`
      - :ref:`env_types_bool`
      - ``on|off``
+   * - :setting:`SLM_IGS_STATION_NAMING`
+     - :ref:`env_types_bool`
+     - ``on|off``
    * - :setting:`SLM_SITE_NAME`
      - :ref:`env_types_bool`
      - ``slm.yourdomain.org``
@@ -445,6 +448,26 @@ Enable or disable the MapBox_ admin map in the SLM. Must be set in the environme
 or prior to the inclusion of ``slm.settings.root``. You may also enable or disable
 the admin map by adding or removing ``slm.map`` from :setting:`INSTALLED_APPS`.
 
+``SLM_IGS_STATION_NAMING`` ⚙️
+------------------------------
+.. setting:: SLM_IGS_STATION_NAMING
+
+Default: ``False``
+
+Enable or disable the use of IGS naming rules for station names. If enabled, the defaults for
+:setting:`SLM_STATION_NAME_REGEX` and :setting:`SLM_STATION_NAME_HELP` will be set to:
+
+.. code-block:: python
+
+    SLM_STATION_NAME_REGEX = r"[\w]{4}[\d]{2}[\w]{3}"
+    SLM_STATION_NAME_HELP = _(
+         "This is the 9 Character station name (XXXXMRCCC) used in RINEX 3 "
+         "filenames Format: (XXXX - existing four character IGS station "
+         "name, M - Monument or marker number (0-9), R - Receiver number "
+         "(0-9), CCC - Three digit ISO 3166-1 country code)"
+    )
+
+
 ``SLM_STATION_NAME_REGEX``
 --------------------------
 .. setting:: SLM_STATION_NAME_REGEX

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

@@ -288,7 +288,7 @@ the first question you can just hit enter to accept the defaults:
       (.venv) ?> touch .env
       (.venv) ?> pip install "igs-slm[debug]"
 
-    Add a minimal configuraton to the .env file. It may look something like this. You may also
+    Add a minimal configuration 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`:
 
@@ -395,10 +395,10 @@ Deploy
   We offer a notional deployment strategy here. There are myriad operational concerns that will vary
   based on your organization's so the following examples are merely suggestions.
 
-The scaffold we generated should be checked into version control. You can manage it just like you
-would a normal python package. It can be built and installed using uv_ or pip_ or any other python
-package management tooling that supports wheels. When you install it it will pull in all of its
-required python dependencies.
+If you are customizing the SLM, the scaffold we generated should be checked into version control.
+You can manage it just like you would a normal python package. It can be built and installed using
+uv_ or pip_ or any other python package management tooling that supports wheels. When you install it
+it will pull in all of its required python dependencies.
 
 First you need to make sure your host server has all the dependencies installed, PostGIS_, etc.
 Then you should use ``psql`` to create the database. It is usually sufficient to configure PostGIS_
@@ -450,31 +450,69 @@ environment somewhere you think is appropriate. For example:
 Build and Install
 -----------------
 
-.. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
+
+    .. code-block:: bash
 
-  # in your git repository holding your slm-startproject
-  ?> uv build
-  # get the wheel to your server somehow
-  ?> scp dist/network-x.x.x-py3-none-any.whl yourserver:./
-  ?> ssh yourserver
-  ?> source /opt/slm_venv/bin/activate
-  # install with gunicorn if using nginx or mod_wsgi if using Apache
-  (slm_venv) ?> pip install network-x.x.x-py3-none-any.whl
-  # if using nginx:
-  (slm_venv) ?> pip install gunicorn
-  # if using apache:
-  (slm_venv) ?> pip install mod_wsgi
+      ?> source /opt/slm_venv/bin/activate
+      # install with gunicorn if using nginx or mod_wsgi if using Apache
+      (slm_venv) ?> pip install igs-slm
+      # if using nginx:
+      (slm_venv) ?> pip install gunicorn
+      # if using apache:
+      (slm_venv) ?> pip install mod_wsgi
+
+  .. tab:: Custom Install
+
+    .. code-block:: bash
+
+      # in your git repository holding your slm-startproject
+      ?> uv build
+      # get the wheel to your server somehow
+      ?> scp dist/network-x.x.x-py3-none-any.whl yourserver:./
+      ?> ssh yourserver
+      ?> source /opt/slm_venv/bin/activate
+      # install with gunicorn if using nginx or mod_wsgi if using Apache
+      (slm_venv) ?> pip install network-x.x.x-py3-none-any.whl
+      # if using nginx:
+      (slm_venv) ?> pip install gunicorn
+      # if using apache:
+      (slm_venv) ?> pip install mod_wsgi
 
 Filesystem
 ----------
 
 We recommend setting up your site's working directory somewhere under /var/www:
 
-.. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
+
+    .. code-block:: bash
+
+      ?> mkdir -p /var/www/network.example.com/production
+      ?> cd /var/www/network.example.com/production
+      ?> mkdir static media logs secrets
+
+    You will need to create an environment file to tell the SLM about itself:
+
+    .. code-block:: bash
+      :caption: /var/www/network.example.com/production/.env
+
+      DEBUG=False
+      BASE_DIR=/var/www/network.example.com/production
+      SLM_ORG_NAME="Example"
+      SLM_SITE_NAME="network.example.com"
+
+  .. tab:: Custom Install
 
-  ?> mkdir -p /var/www/network.example.com/production
-  ?> cd /var/www/network.example.com/production
-  ?> mkdir static media logs secrets
+  .. code-block:: bash
+
+    ?> mkdir -p /var/www/network.example.com/production
+    ?> cd /var/www/network.example.com/production
+    ?> mkdir static media logs secrets
 
 web servers
 -----------
@@ -549,6 +587,7 @@ web servers
       User=www-data
       Group=www-data
       WorkingDirectory=/var/www/network.example.com/production
+      Environment="SLM_ENV=/var/www/network.example.com/production/.env"
       ExecStart=/opt/slm_venv/bin/gunicorn --workers 4 --bind unix:/var/www/network.example.com/production/slm.sock sites.network.production.wsgi:application
 
       [Install]
@@ -584,6 +623,13 @@ web servers
           # WSGI configuration
           WSGIDaemonProcess network python-home=/opt/slm_venv python-path=/var/www/network.example.com/production
           WSGIProcessGroup network
+
+          WSGIEnvVar SLM_ENV /var/www/network.example.com/production/.env
+
+          # TODO - For Basic Install:
+          WSGIScriptAlias / /opt/slm_venv/lib/python3.x/site-packages/slm/wsgi.py
+
+          # TODO - For Custom Install:
           WSGIScriptAlias / /opt/slm_venv/lib/python3.x/site-packages/sites/network/production/wsgi.py
 
           # Static & media files
@@ -610,9 +656,32 @@ routine deploy
 Anytime you install a new version of your SLM you need to run :django-admin:`routine deploy`. This
 will migrate the database and bundle all static files:
 
-.. code-block:: bash
 
-  (slm_venv) ?> network routine deploy
+.. tabs::
+
+  .. tab:: Basic Install
+
+    .. code-block:: bash
+
+      (slm_venv) ?> slm routine deploy
+
+    If it is the first installation you can run the :django-admin:`routine install` routine instead:
+
+    .. code-block:: bash
+
+      (slm_venv) ?> slm routine install
+
+  .. tab:: Custom Install
+
+    .. code-block:: bash
+
+      (slm_venv) ?> network routine deploy
+
+    If it is the first installation you can run the :django-admin:`routine install` routine instead:
+
+    .. code-block:: bash
+
+      (slm_venv) ?> network routine install
 
 
 .. tip::

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

@@ -1,6 +1,6 @@
 [project]
 name = "igs-slm"
-version = "0.1.5b2"
+version = "0.1.5b3"
 description = "IGS Site Log Manager"
 requires-python = ">=3.8,<4.0"
 authors = [

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

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

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

@@ -186,15 +186,18 @@ set_default(
 # instance than the instance that generates serialized artifacts
 SLM_FILE_DOMAIN = None
 
-
-set_default("SLM_STATION_NAME_REGEX", None)
-set_default("SLM_STATION_NAME_HELP", _("The name of the station."))
-
-# IGS Settings:
-# SLM_STATION_NAME_REGEX = r"[\w]{4}[\d]{2}[\w]{3}"
-# SLM_STATION_NAME_HELP = _(
-#     "This is the 9 Character station name (XXXXMRCCC) used in RINEX 3 "
-#     "filenames Format: (XXXX - existing four character IGS station "
-#     "name, M - Monument or marker number (0-9), R - Receiver number "
-#     "(0-9), CCC - Three digit ISO 3166-1 country code)"
-# )
+SLM_IGS_STATION_NAMING = env(
+    "SLM_IGS_STATION_NAMING", default=get_setting("SLM_IGS_STATION_NAMING", False)
+)
+if SLM_IGS_STATION_NAMING:
+    # Use IGS naming rules for station names:
+    SLM_STATION_NAME_REGEX = r"[\w]{4}[\d]{2}[\w]{3}"
+    SLM_STATION_NAME_HELP = _(
+        "This is the 9 Character station name (XXXXMRCCC) used in RINEX 3 "
+        "filenames Format: (XXXX - existing four character IGS station "
+        "name, M - Monument or marker number (0-9), R - Receiver number "
+        "(0-9), CCC - Three digit ISO 3166-1 country code)"
+    )
+else:
+    set_default("SLM_STATION_NAME_REGEX", None)
+    set_default("SLM_STATION_NAME_HELP", _("The name of the station."))

{igs_slm-0.1.5b2 → igs_slm-0.1.5b3}/src/slm/signals.py

@@ -1,6 +1,7 @@
 """
-All SLM specific signals sent by the system are defined here. These signals
-mostly include events relating to the site log edit/moderate/publish life cycle.
+All SLM specific :doc:`django:topics/signals` sent by the system are defined here.
+These signals mostly include events relating to the site log edit/moderate/publish life
+cycle.
 
 All signals contain a request object that holds the request that initiated the
 event. This object is provided mostly for logging purposes and is not
@@ -12,6 +13,7 @@ import sys
 from django.dispatch import Signal
 from django.utils.module_loading import import_string
 
+site_proposed = Signal()
 """
 Signal sent when a new site is proposed.
 
@@ -24,8 +26,9 @@ Signal sent when a new site is proposed.
     responsible agencies.
 :param kwargs: Misc other key word arguments
 """
-site_proposed = Signal()
 
+
+site_published = Signal()
 """
 Sent when a site log is published, or when a section of a site log is
 published.
@@ -39,8 +42,9 @@ published.
     section was published this will be the Section object instance.
 :param kwargs: Misc other key word arguments
 """
-site_published = Signal()
 
+
+site_status_changed = Signal()
 """
 Sent when a site log is published, or when a section of a site log is
 published. Its possible that both the previous and new status states are
@@ -54,8 +58,9 @@ The published timestamp will have increased.
 :param reverted: If true this status change was the result of a reversion
 :param kwargs: Misc other key word arguments
 """
-site_status_changed = Signal()
 
+
+section_edited = Signal()
 """
 Sent when a site log section is edited.
 
@@ -68,8 +73,9 @@ Sent when a site log section is edited.
 :param fields: The list of edited fields
 :param kwargs: Misc other key word arguments
 """
-section_edited = Signal()
 
+
+section_added = Signal()
 """
 Sent when a site log section is added.
 
@@ -81,8 +87,9 @@ Sent when a site log section is added.
 :param section: The section object that was added.
 :param kwargs: Misc other key word arguments
 """
-section_added = Signal()
 
+
+section_deleted = Signal()
 """
 Sent when a site log section is deleted.
 
@@ -94,8 +101,9 @@ Sent when a site log section is deleted.
 :param section: The section object that was deleted.
 :param kwargs: Misc other key word arguments
 """
-section_deleted = Signal()
 
+
+fields_flagged = Signal()
 """
 Sent when a site log section has fields flagged.
 
@@ -109,8 +117,9 @@ Sent when a site log section has fields flagged.
 :param fields: The list of fields that were flagged.
 :param kwargs: Misc other key word arguments
 """
-fields_flagged = Signal()
 
+
+flags_cleared = Signal()
 """
 Sent when a site log section has fields flagged.
 
@@ -126,8 +135,9 @@ Sent when a site log section has fields flagged.
 :param clear: True if the section has no remaining flags - false otherwise.
 :param kwargs: Misc other key word arguments
 """
-flags_cleared = Signal()
 
+
+site_file_uploaded = Signal()
 """
 Sent when a user uploads a site log.
 
@@ -139,8 +149,9 @@ Sent when a user uploads a site log.
 :param upload: The uploaded file (SiteFileUpload).
 :param kwargs: Misc other key word arguments
 """
-site_file_uploaded = Signal()
 
+
+site_file_published = Signal()
 """
 Sent when a moderator publishes a site file upload - could be an attachment or
 an image.
@@ -153,9 +164,9 @@ an image.
 :param upload: The uploaded file (SiteFileUpload).
 :param kwargs: Misc other key word arguments
 """
-site_file_published = Signal()
 
 
+site_file_unpublished = Signal()
 """
 Sent when a moderator retracts a site file upload - could be an attachment
 or an image.
@@ -168,9 +179,9 @@ or an image.
 :param upload: The uploaded file (SiteFileUpload).
 :param kwargs: Misc other key word arguments
 """
-site_file_unpublished = Signal()
 
 
+site_file_deleted = Signal()
 """
 Sent when a user deletes a site file upload through the API. The file must be
 a type other than a site log - could be an attachment or an image.
@@ -183,9 +194,9 @@ a type other than a site log - could be an attachment or an image.
 :param upload: The uploaded file (SiteFileUpload).
 :param kwargs: Misc other key word arguments
 """
-site_file_deleted = Signal()
 
 
+review_requested = Signal()
 """
 Sent when a user requests a site log be reviewed and published by moderators.
 
@@ -195,8 +206,8 @@ Sent when a user requests a site log be reviewed and published by moderators.
 :param request: The Django request object that contained the request.
 :param kwargs: Misc other key word arguments
 """
-review_requested = Signal()
 
+updates_rejected = Signal()
 """
 Sent when a moderator rejects edits requested for publish in a review request.
 
@@ -206,8 +217,9 @@ Sent when a moderator rejects edits requested for publish in a review request.
 :param request: The Django request object that contained the rejection.
 :param kwargs: Misc other key word arguments
 """
-updates_rejected = Signal()
 
+
+alert_issued = Signal()
 """
 Sent when an alert is issued.
 
@@ -215,8 +227,9 @@ Sent when an alert is issued.
 :param alert: The alert object that was issued.
 :param kwargs: Misc other key word arguments
 """
-alert_issued = Signal()
 
+
+alert_cleared = Signal()
 """
 Sent when an alert is cleared.
 
@@ -224,8 +237,6 @@ Sent when an alert is cleared.
 :param alert: The alert object that was issued.
 :param kwargs: Misc other key word arguments
 """
-alert_cleared = Signal()
-
 
 _signal_names_ = {
     value: f"slm.signals.{key}"

{igs_slm-0.1.5b2 → igs_slm-0.1.5b3}/src/slm/templatetags/slm.py

@@ -254,11 +254,11 @@ def file_icon(file):
 @register.filter(name="file_lines")
 def file_lines(file):
     if isinstance(file, str):
-        return file.split("\n")
+        return file.splitlines()
     if file and os.path.exists(file.file.path):
         content = file.file.open().read()
         try:
-            return content.decode(detect(content).get("encoding", "utf-8")).split("\n")
+            return content.decode(detect(content).get("encoding", "utf-8")).splitlines()
         except (UnicodeDecodeError, LookupError, ValueError):
             return [
                 _("** Unable to determine text encoding - please upload as UTF-8. **")

{igs_slm-0.1.5b2 → igs_slm-0.1.5b3}/uv.lock

@@ -1423,7 +1423,7 @@ wheels = [
 
 [[package]]
 name = "igs-slm"
-version = "0.1.5b2"
+version = "0.1.5b3"
 source = { editable = "." }
 dependencies = [
     { name = "chardet" },