igs-slm 0.1.2b0__py3-none-any.whl → 0.1.5b0__py3-none-any.whl

slm/__init__.py

@@ -1,21 +1,24 @@
 r"""
- .----------------.  .----------------.  .----------------.
-| .--------------. || .--------------. || .--------------. |
-| |    _______   | || |   _____      | || | ____    ____ | |
-| |   /  ___  |  | || |  |_   _|     | || ||_   \  /   _|| |
-| |  |  (__ \_|  | || |    | |       | || |  |   \/   |  | |
-| |   '.___`-.   | || |    | |   _   | || |  | |\  /| |  | |
-| |  |`\____) |  | || |   _| |__/ |  | || | _| |_\/_| |_ | |
-| |  |_______.'  | || |  |________|  | || ||_____||_____|| |
-| |              | || |              | || |              | |
-| '--------------' || '--------------' || '--------------' |
- '----------------'  '----------------'  '----------------'
+::
+
+    .----------------.  .----------------.  .----------------.
+    | .--------------. || .--------------. || .--------------. |
+    | |    _______   | || |   _____      | || | ____    ____ | |
+    | |   /  ___  |  | || |  |_   _|     | || ||_   \  /   _|| |
+    | |  |  (__ \_|  | || |    | |       | || |  |   \/   |  | |
+    | |   '.___`-.   | || |    | |   _   | || |  | |\  /| |  | |
+    | |  |`\____) |  | || |   _| |__/ |  | || | _| |_\/_| |_ | |
+    | |  |_______.'  | || |  |________|  | || ||_____||_____|| |
+    | |              | || |              | || |              | |
+    | '--------------' || '--------------' || '--------------' |
+    '----------------'  '----------------'  '----------------'
+
 """
 
-VERSION = (0, 1, "2b")
+VERSION = (0, 1, "5b0")
 
 __title__ = "IGS/Site Log Manager"
 __version__ = ".".join(str(i) for i in VERSION)
-__author__ = ["Ashley Santiago", "Brian Kohan", "Rachel Pham"]
+__author__ = "Ashley Santiago, Brian Kohan, Rachel Pham, Robert Khachikyan"
 __license__ = "MIT"
-__copyright__ = "Copyright 2022-2024 International GNSS Service"
+__copyright__ = "Copyright 2022-2025 International GNSS Service"

slm/admin.py

@@ -27,6 +27,7 @@ from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
 from django.contrib.auth.models import Group
 from django.db.models import BooleanField, Count, Q
 from django.db.models.expressions import ExpressionWrapper
+from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 from polymorphic.admin import (
@@ -281,6 +282,11 @@ class NetworkAdmin(admin.ModelAdmin):
     ordering = ("name",)
     list_filter = ("public",)
 
+    def formfield_for_manytomany(self, db_field, request, **kwargs):
+        if db_field.name == "sites":
+            kwargs["queryset"] = Site.objects.order_by("name")
+        return super().formfield_for_manytomany(db_field, request, **kwargs)
+
 
 class AgencyUserInline(admin.TabularInline):
     model = Agency.users.through
@@ -459,29 +465,50 @@ class ArchiveFileInline(admin.TabularInline):
         field.name if field.name != "file" else "path"
         for field in ArchivedSiteLog._meta.get_fields()
         if field.name not in ["id", "site", "thumbnail", "name", "timestamp"]
-    ]
+    ] + ["view_file"]
     can_delete = False
     exclude = ["site", "file", "thumbnail", "name", "timestamp"]
 
     def path(self, obj):
-        return obj.file.path
+        return format_html('<a href="{}" download>{}</a>', obj.link, obj.file.name)
 
     def has_add_permission(self, request, obj):
         return False
 
+    def view_file(self, obj):
+        if obj.pk:
+            return format_html(
+                '<button type="button" class="button view-file" data-url="{}">{}</button>',
+                obj.link,
+                _("View"),
+            )
+        return ""
+
+    view_file.short_description = _("View")
+
 
 class ArchiveIndexAdmin(admin.ModelAdmin):
     search_fields = ["site__name"]
     list_display = ("site", "begin", "end")
 
-    ordering = ("-begin",)
-
     inlines = [ArchiveFileInline]
-    readonly_fields = ["site", "begin", "end"]
+    readonly_fields = ["site"]
+
+    def begin(self, obj):
+        return obj.begin
+
+    def end(self, obj):
+        return obj.end
 
     def get_queryset(self, request):
         return self.model.objects.select_related("site").prefetch_related("files")
 
+    class Media:
+        js = (
+            "admin/js/jquery.init.js",
+            "slm/js/file_modal.js",
+        )
+
 
 """
 class SLMAdminSite(admin.AdminSite):

slm/api/edit/views.py

@@ -726,11 +726,12 @@ class SectionViewSet(type):
                         #   also needs to be DRYed w/ published_diff function
                         for field in ModelClass.site_log_fields():
                             if field in validated_data:
-                                is_many = isinstance(
-                                    instance._meta.get_field(field),
-                                    models.ManyToManyField,
-                                )
+                                mdl_field = instance._meta.get_field(field)
+                                is_many = isinstance(mdl_field, models.ManyToManyField)
                                 new_value = validated_data.get(field)
+                                if new_value is None and not mdl_field.null:
+                                    # convert Nones to empty strings if warranted
+                                    new_value = mdl_field.default
                                 old_value = getattr(instance, field)
                                 if (
                                     not is_many
@@ -1327,7 +1328,7 @@ class SiteFileUploadViewSet(
                                 {
                                     "file": upload.id,
                                     "error": _(
-                                        "There were errors parsing the site " "log."
+                                        "There were errors parsing the site log."
                                     ),
                                 },
                                 status=400,
@@ -1372,7 +1373,7 @@ class SiteFileUploadViewSet(
                                 {
                                     "file": upload.id,
                                     "error": _(
-                                        "There were errors parsing the site " "log."
+                                        "There were errors parsing the site log."
                                     ),
                                 },
                                 status=400,
@@ -1483,12 +1484,24 @@ class SiteFileUploadViewSet(
             # ensure that the prepared by field will be set to what was given
             # in the upload log
             for index, section in reversed(parsed.sections.items()):
-                if section.example or not section.contains_values:
+                if section.example:
                     continue
-
                 section_view = self.SECTION_VIEWS.get(section.heading_index, None)
+                # this is a complicated conditional to determine if the section is a subsection
+                # header with no bindable values - think about encapsulating this logic onto
+                # the binder
+                if (
+                    section_view
+                    and issubclass(
+                        section_view.serializer_class.Meta.model, SiteSubSection
+                    )
+                    and not isinstance(section.order, int)
+                    and not section.contains_values
+                ):
+                    # skip subsection headers
+                    continue
                 if section_view:
-                    data = {**section.binding, "site": self.site.id}
+                    data = {**(section.binding or {}), "site": self.site.id}
                     subsection_number = self.get_subsection_id(section)
                     if subsection_number is not None:
                         # we have to find the right subsection identifiers

slm/api/public/views.py

@@ -1,5 +1,5 @@
 import json
-from datetime import datetime
+from datetime import datetime, timezone
 
 import django_filters
 from crispy_forms.helper import FormHelper
@@ -304,7 +304,7 @@ class SiteFileUploadViewSet(
 
     filter_backends = (DjangoFilterBackend, OrderingFilter)
     filterset_class = FileFilter
-    ordering_fields = ["-timestamp", "name", "site"]
+    ordering_fields = ("timestamp", "name", "site")
 
     def get_queryset(self):
         return SiteFileUpload.objects.public().select_related("site")
@@ -565,6 +565,8 @@ class ArchiveViewSet(
     permission_classes = []
 
     class ArchiveFilter(CrispyFormCompat, FilterSet):
+        NULL_EPOCH = datetime.max.replace(tzinfo=timezone.utc)
+
         site = django_filters.CharFilter(
             field_name="site__name",
             help_text=_("The site of the archived log to download."),
@@ -577,17 +579,17 @@ class ArchiveViewSet(
 
         epoch = SLMDateTimeFilter(
             method="at_epoch",
-            initial=lambda: datetime.now(),
+            initial=NULL_EPOCH,
             help_text=_(
-                "Get the archive that was active at this given date or " "datetime."
+                "Get the archive that was active at this given date or datetime."
             ),
         )
 
         def at_epoch(self, queryset, name, value):
-            return queryset.filter(
-                Q(index__begin__lte=value)
-                & (Q(index__end__isnull=True) | Q(index__end__gt=value))
-            )
+            if value == self.NULL_EPOCH:
+                return queryset.order_by("-valid_range")[:1]
+            else:
+                return queryset.filter(valid_range__contains=value)
 
         class Meta:
             model = ArchivedSiteLog

slm/api/views.py

@@ -1,11 +1,11 @@
-from datetime import datetime
+from datetime import datetime, timezone
 
-from django.db.models import Q
 from django.http import FileResponse
 from django.utils.translation import gettext as _
 from django_filters import filters
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework import mixins, renderers, viewsets
+from rest_framework.generics import get_object_or_404
 
 from slm.api.filter import InitialValueFilterSet, SLMDateTimeFilter
 from slm.defines import SiteLogFormat
@@ -71,9 +71,11 @@ class BaseSiteLogDownloadViewSet(mixins.RetrieveModelMixin, viewsets.GenericView
     queryset = ArchiveIndex.objects.all()
 
     class ArchiveIndexFilter(InitialValueFilterSet):
+        NULL_EPOCH = datetime.max.replace(tzinfo=timezone.utc)
+
         epoch = SLMDateTimeFilter(
             method="at_epoch",
-            initial=lambda: datetime.now(),
+            initial=NULL_EPOCH,
             help_text=_("Get the log that was active at this given date or datetime."),
         )
 
@@ -90,9 +92,17 @@ class BaseSiteLogDownloadViewSet(mixins.RetrieveModelMixin, viewsets.GenericView
         )
 
         def at_epoch(self, queryset, name, value):
-            return queryset.filter(
-                Q(begin__lte=value) & (Q(end__isnull=True) | Q(end__gt=value))
-            )
+            if value == self.NULL_EPOCH:
+                # # this does not work because it pulls the most recent site log *first* - would need to
+                # # do this after the site log filter!
+                # last_index =  Subquery(
+                #     queryset.order_by(Func('valid_range', function='lower').desc())
+                #             .values('valid_range')[:1]
+                # )
+                # return queryset.filter(valid_range=last_index)
+                return queryset.order_by("-valid_range")[:1]
+            else:
+                return queryset.filter(valid_range__contains=value)
 
         def noop(self, queryset, _1, _2):
             return queryset
@@ -104,6 +114,35 @@ class BaseSiteLogDownloadViewSet(mixins.RetrieveModelMixin, viewsets.GenericView
     filter_backends = (DjangoFilterBackend,)
     filterset_class = ArchiveIndexFilter
 
+    def get_object(self):
+        """
+        We override get_object so we can apply the station lookup first to the queryset.
+
+        This is necessary because the at_epoch query uses a subquery.
+        """
+        # Perform the lookup filtering.
+        lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
+
+        assert lookup_url_kwarg in self.kwargs, (
+            "Expected view %s to be called with a URL keyword argument "
+            'named "%s". Fix your URL conf, or set the `.lookup_field` '
+            "attribute on the view correctly."
+            % (self.__class__.__name__, lookup_url_kwarg)
+        )
+
+        obj = get_object_or_404(
+            self.filter_queryset(
+                self.get_queryset().filter(
+                    **{self.lookup_field: self.kwargs[lookup_url_kwarg]}
+                )
+            )
+        )
+
+        # May raise a permission denied
+        self.check_object_permissions(self.request, obj)
+
+        return obj
+
     def get_format_suffix(self, **kwargs):
         requested_format = super().get_format_suffix(**kwargs)
 

slm/apps.py

@@ -1,3 +1,4 @@
+import shutil
 import sys
 from pprint import pformat
 
@@ -20,6 +21,30 @@ from slm.signals import signal_name
 from slm.utils import clear_caches
 
 
+@register("slm", Tags.staticfiles)
+def check_node_available(**kwargs):
+    if (
+        any(
+            (
+                cmd.startswith("npx")
+                for _, cmd in getattr(settings, "COMPRESS_PRECOMPILERS", [])
+            )
+        )
+        and shutil.which("npx") is None
+    ):
+        return [
+            Warning(
+                "nodejs is not available.",
+                hint=(
+                    "Make sure nodejs is installed so esbuild can be used to bundle "
+                    "static assets. (https://nodejs.org/en/download)"
+                ),
+                id="slm.W002",
+            )
+        ]
+    return []
+
+
 @register("slm", Tags.security)
 def check_permission_groups_setting(**kwargs):
     error_id = "slm.E002"
@@ -81,10 +106,7 @@ def check_permissions_setting(**kwargs):
         except ImportError:
             return [
                 Warning(
-                    _(
-                        f"Was unable to load SLM_PERMISSIONS callable: "
-                        f"{permissions}"
-                    ),
+                    _(f"Was unable to load SLM_PERMISSIONS callable: {permissions}"),
                     hint=_(
                         "Set SLM_PERMISSIONS to the import string for a "
                         "callable that returns a queryset of valid system"
@@ -158,8 +180,7 @@ def check_automated_alerts(**kwargs):
                         errors.append(
                             alert_conf_error(
                                 _(
-                                    "SLM_AUTOMATED_ALERTS[{}][{}][{}] is not a "
-                                    "Signal"
+                                    "SLM_AUTOMATED_ALERTS[{}][{}][{}] is not a Signal"
                                 ).format(alert, signal_type, signal_name(signal)),
                             )
                         )
@@ -262,6 +283,7 @@ def site_save(sender, instance, created, raw, using, update_fields, **kwargs):
             site=instance,
             previous_status=instance._slm_pre_status,
             new_status=instance.status,
+            reverted=getattr(instance, "_reverted", False),
         )
 
 

slm/authentication.py

@@ -15,7 +15,9 @@ from allauth.account.utils import user_pk_to_url_str, user_username
 from allauth.utils import build_absolute_uri
 from django.conf import settings
 from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Permission
 from django.contrib.sites.shortcuts import get_current_site
+from django.db.models import QuerySet
 from django.urls import reverse
 from django.utils.module_loading import import_string
 from rest_framework import authentication, exceptions
@@ -187,9 +189,8 @@ def permissions():
         return Permission.objects.all()
 
 
-def default_permissions():
+def default_permissions() -> QuerySet[Permission]:
     from django.contrib.auth import get_user_model
-    from django.contrib.auth.models import Permission
     from django.contrib.contenttypes.models import ContentType
 
     return Permission.objects.filter(

slm/bin/startproject.py

@@ -1,12 +1,15 @@
 import os
+import re
 import shutil
 import sys
 from pathlib import Path
 from urllib.parse import urlparse
 
 import django
+import environ
 from django.conf import settings
 from django_typer.completers import complete_path
+from packaging.version import Version
 from render_static.engine import StaticTemplateEngine
 from rich.console import Console
 from rich.markdown import Markdown
@@ -36,36 +39,59 @@ REPORT_MARKDOWN = """
 
 ### Installation Instructions
 
-1. Create a database called `{site}`.
+1. Create a database called `{database_name}`.
 
-2. Use `poetry` to install your project's virtual environment:
+2. Use `uv` to install your project's virtual environment:
 
-    {install_poetry}
+    {install_uv}
 
     Install dependencies:
 
     ```bash
-    poetry install
+    uv sync --all-extras
     ```
 
 3. To install your database and import existing sitelogs, run:
     
     ```bash
-    {site} routine install
+    uv run {site} routine install
     ```
 
 4. To run the development server, run:
     
     ```bash
-    network runserver
+    uv run {site} runserver
     ```
 """
 
-INSTALL_POETRY = """
-    **You do not have `poetry` installed, see**: https://python-poetry.org/docs/#installing-with-the-official-installer
+INSTALL_UV = """
+    **You do not have `uv` installed, see**: https://docs.astral.sh/uv/getting-started/installation/
 """
 
 
+def sanitize_package_dir(name: str) -> str:
+    """
+    Convert an arbitrary string to a valid Python importable name.
+
+    Rules:
+    - Replace any non-alphanumeric character with underscore.
+    - Collapse multiple underscores.
+    - Remove leading/trailing underscores.
+    - Lowercase the result.
+    """
+    return re.sub(r"_+", "_", re.sub(r"[^A-Za-z0-9]+", "_", name)).strip("_").lower()
+
+
+def sanitize_package_name(name: str) -> str:
+    """
+    Replace illegal characters in a package name with underscores
+    according to PyPI naming rules (PEP 508).
+    """
+    return re.sub(
+        r"_+", "_", re.sub(r"[^A-Za-z0-9._-]+", "_", name).strip(".-")
+    ).lower()
+
+
 @app.command(
     help="Create a directory structure for an slm deployment. This includes settings files and an extension app. You can change any names or settings at a later time!"
 )
@@ -84,7 +110,7 @@ def main(
             prompt="What is the name of your organization?",
             help="What is the name of your organization?",
         ),
-    ] = "",
+    ] = "{domain}",
     project_dir: Annotated[
         str,
         Option(
@@ -120,22 +146,29 @@ def main(
             help="What should we call your custom Django app?",
         ),
     ] = "{org}_extensions",
+    database: Annotated[
+        str,
+        Option(
+            prompt="How should we connect to the database (db url)?",
+            help="How should we connect to the database (db url)?",
+        ),
+    ] = "postgis:///{site}",
     include_map: Annotated[
         bool,
         Option(
-            "--include-map",
+            "--no-include-map",
             prompt="Install the mapbox map app?",
             help="Install the mapbox map app?",
         ),
-    ] = False,
+    ] = True,
     use_igs_validation: Annotated[
         bool,
         Option(
-            "--use-igs-validation",
+            "--no-use-igs-validation",
             prompt="Use IGS sitelog validation defaults?",
             help="Use IGS sitelog validation defaults?",
         ),
-    ] = False,
+    ] = True,
 ):
     netloc = (urlparse(netloc).netloc or netloc).lower()
     parts = netloc.split(".")
@@ -186,13 +219,28 @@ def main(
             ]
         }
     )
-    if not organization:
-        organization = domain.title()
-    org = organization.replace(" ", "_").lower()
-    extension_app = extension_app.format(org=(org or "slm"))
+    if not organization or organization == "{domain}":
+        parts = domain.split(".")
+        organization = parts[0]
+        if len(parts) > 1:
+            organization = parts[-2]
+        organization = organization.title()
+    org = organization.replace(" ", "_").replace(".", "_").lower()
+    extension_app = sanitize_package_dir(extension_app.format(org=(org or "slm")))
     site = site.format(subdomain=subdomain).replace(" ", "_").lower()
     project_dir = project_dir.format(subdomain=subdomain)
-    package_name = package_name.format(project_dir=project_dir)
+    package_name = sanitize_package_name(package_name.format(project_dir=project_dir))
+    database = database.format(site=site)
+    if database.isalpha():
+        database = f"postgis:///{database}"
+
+    env = environ.Env()
+    database_name = env.db_url_config(
+        database, engine="django.contrib.gis.db.backends.postgis"
+    )["NAME"]
+
+    if not database_name:
+        raise
 
     # find site packages dir
     local_slm = None
@@ -200,16 +248,33 @@ def main(
     for pth in (Path(pth) for pth in sys.path):
         if pth.name == "site-packages":
             if pth not in slm_pth.parents:
-                if yes(
-                    input(
-                        "It looks like you are using a local clone of the SLM, would "
-                        "you prefer to use this instead of a release on pypi? (Y/n): "
-                    )
-                ):
-                    local_slm = os.path.relpath(
-                        slm_pth.parent, directory.absolute().resolve() / project_dir
-                    )
+                local_slm = os.path.relpath(
+                    slm_pth.parent.parent,
+                    directory.absolute().resolve() / project_dir,
+                )
                 break
+            else:
+                # uvx --from path edge case
+                import json
+                from importlib.metadata import version
+
+                direct_url = (
+                    pth / f"igs_slm-{version('igs-slm')}.dist-info" / "direct_url.json"
+                )
+                if direct_url.is_file():
+                    installed_from = json.loads(direct_url.read_text()).get("url", None)
+                    if installed_from.startswith("file:///"):
+                        local_slm = str(Path(installed_from[7:]).resolve())
+                        break
+
+    if local_slm:
+        if not yes(
+            input(
+                "It looks like you are using a local clone of the SLM, would "
+                "you prefer to use this instead of a release on pypi? (Y/n): "
+            )
+        ):
+            local_slm = None
 
     ctx = {
         "netloc": netloc,
@@ -218,8 +283,11 @@ def main(
         "org": org,
         "project_dir": project_dir,
         "site": site,
+        "database": database,
+        "database_name": database_name,
         "production_dir": production_dir.format(site=site),
         "slm_version": slm.__version__,
+        "slm_version_next_major": f"{Version(slm.__version__).major + 1}.0",
         "extension_app_class": extension_app.title().replace(" ", "").replace("_", ""),
         "extension_app": extension_app.replace(" ", "_").lower(),
         "include_map": include_map,
@@ -231,17 +299,19 @@ def main(
         "{{ project_dir }}/**",
         context=ctx,
         dest=directory,
-        exclude=[template_dir / "{{ project_dir }}/{{ extension_app }}/templates"],
+        exclude=[template_dir / "{{ project_dir }}/src/{{ extension_app }}/templates"],
     )
     engine.render_to_disk(
-        "{{ project_dir }}/{{ extension_app }}/templates/**",
+        "{{ project_dir }}/src/{{ extension_app }}/templates/**",
         context=ctx,
         dest=directory,
         render_contents=False,
     )
 
     output = (directory / project_dir).absolute().resolve()
-    assert output.is_dir() and output.exists()
+    assert output.is_dir() and output.exists(), (
+        f"Failed to create project directory: {output}"
+    )
 
     Console().print(
         Markdown(
@@ -250,11 +320,12 @@ def main(
                 develop=(output / "sites" / site / "develop/__init__.py").relative_to(
                     output
                 ),
+                database_name=database_name,
                 production=(
                     output / "sites" / site / "production/__init__.py"
                 ).relative_to(output),
                 site=site,
-                install_poetry=INSTALL_POETRY if not shutil.which("poetry") else "",
+                install_uv=INSTALL_UV if not shutil.which("uv") else "",
                 pyproject=(output / "pyproject.toml").relative_to(output),
             )
         )