ophix-admin-settings 2026.10.4.1__tar.gz

ophix_admin_settings-2026.10.4.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: ophix-admin-settings
+Version: 2026.10.4.1
+Summary: Instance settings for Ophix Project Servers - server identity, environment, and language
+Author: Ophix Project
+License-Expression: MIT
+Project-URL: Homepage, https://ophix.io
+Keywords: django,ophix,admin,settings
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: django-colorfield
+Requires-Dist: ophix-server-base>=2026.06.08.01
+
+# ophix-admin-settings
+
+**Know which server you're looking at, every time** — instance identity and environment labelling for every [Ophix](https://ophix.io) server.
+
+Running the same admin UI across a dozen servers makes it easy to lose track of which one is actually in front of you — and that's exactly the moment someone edits production thinking it's staging. `ophix-admin-settings` gives every server its own title and a visible environment badge (Production, Staging, Dev, or whatever you call it), right in the header and favicon, so there's never any doubt.
+
+This package is automatically included in every Ophix server, no need to separately install it.
+
+---
+
+## What it does
+
+Provides a singleton **Server Settings** admin page containing settings that are instance-specific rather than theme-specific. These settings survive theme changes — switching from one theme to another does not alter the server's identity or environment label.
+
+| Setting | Description |
+| --- | --- |
+| **Title** | Displayed in the browser tab and admin header (e.g. `TaskServer`, `CredServer`) |
+| **Title visible** | Toggle title display in the admin header |
+| **Environment name** | Short label shown in the header and favicon (e.g. `Production`, `Staging`, `Dev`) |
+| **Env visible in header** | Show or hide the environment badge in the page header |
+| **Env visible in favicon** | Show or hide the environment marker on the favicon |
+| **Language chooser** | Active, control style (default/minimal), and display format (code/name) |
+
+---
+
+## Installation
+
+Installed automatically with `ophix-admin-interface`. To install explicitly:
+
+```bash
+pip install ophix-admin-settings
+```
+
+Run migrations after installation:
+
+```bash
+ophix-manage migrate
+```
+
+On first `migrate`, the **title** field is pre-populated from the `SERVER_NAME` setting in `.env` if it is blank.
+
+---
+
+## Docs import
+
+```bash
+ophix-manage update_docs --include-app-docs ophix.core,ophix_admin_settings,ophix_docs
+```

ophix_admin_settings-2026.10.4.1/README.md

@@ -0,0 +1,48 @@
+# ophix-admin-settings
+
+**Know which server you're looking at, every time** — instance identity and environment labelling for every [Ophix](https://ophix.io) server.
+
+Running the same admin UI across a dozen servers makes it easy to lose track of which one is actually in front of you — and that's exactly the moment someone edits production thinking it's staging. `ophix-admin-settings` gives every server its own title and a visible environment badge (Production, Staging, Dev, or whatever you call it), right in the header and favicon, so there's never any doubt.
+
+This package is automatically included in every Ophix server, no need to separately install it.
+
+---
+
+## What it does
+
+Provides a singleton **Server Settings** admin page containing settings that are instance-specific rather than theme-specific. These settings survive theme changes — switching from one theme to another does not alter the server's identity or environment label.
+
+| Setting | Description |
+| --- | --- |
+| **Title** | Displayed in the browser tab and admin header (e.g. `TaskServer`, `CredServer`) |
+| **Title visible** | Toggle title display in the admin header |
+| **Environment name** | Short label shown in the header and favicon (e.g. `Production`, `Staging`, `Dev`) |
+| **Env visible in header** | Show or hide the environment badge in the page header |
+| **Env visible in favicon** | Show or hide the environment marker on the favicon |
+| **Language chooser** | Active, control style (default/minimal), and display format (code/name) |
+
+---
+
+## Installation
+
+Installed automatically with `ophix-admin-interface`. To install explicitly:
+
+```bash
+pip install ophix-admin-settings
+```
+
+Run migrations after installation:
+
+```bash
+ophix-manage migrate
+```
+
+On first `migrate`, the **title** field is pre-populated from the `SERVER_NAME` setting in `.env` if it is blank.
+
+---
+
+## Docs import
+
+```bash
+ophix-manage update_docs --include-app-docs ophix.core,ophix_admin_settings,ophix_docs
+```

ophix_admin_settings-2026.10.4.1/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ophix-admin-settings"
+version = "2026.10.04.01"
+description = "Instance settings for Ophix Project Servers - server identity, environment, and language"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Ophix Project" }
+]
+keywords = ["django", "ophix", "admin", "settings"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "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",
+]
+dependencies = [
+    "django-colorfield",
+    "ophix-server-base>=2026.06.08.01",
+]
+
+[project.urls]
+Homepage = "https://ophix.io"
+
+[project.entry-points."ophix.plugins"]
+ophix_admin_settings = "ophix_admin_settings"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"ophix_admin_settings" = [
+    "OPHIX_RELEASE_NOTES.md",
+    "deploy_templates/**/*",
+    "docs/**/*",
+    "static/**/*",
+    "templates/**/*",
+]

ophix_admin_settings-2026.10.4.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/OPHIX_RELEASE_NOTES.md

@@ -0,0 +1,37 @@
+# Ophix Admin Settings Release Notes
+
+## 2026.10.04.01
+
+- Reworked `README.md`'s opening with a hook-first pitch (instance identity and environment
+  labelling — knowing which server you're looking at before you edit it), as part of the
+  16-package taskserver-release-wave README overhaul.
+
+## 2026.09.26.01
+
+- Verified real compatibility under Python 3.14 (not just added the classifier) as part of the taskserver-release-wave compatibility sweep, and added `Programming Language :: Python :: 3.14` to the package classifiers.
+
+## 2026.06.11.01
+
+- Added `message_autohide_enabled` and `message_autohide_delay` fields to `ServerSettings`.
+  When enabled, success and info message banners are automatically dismissed after the
+  configured delay (default 4000 ms). Errors and warnings are never auto-hidden.
+  Exposed in the new "Notifications" section of the Server Settings admin page.
+
+## 2026.06.09.02
+
+- Added `export_settings` management command — exports the `ServerSettings` singleton
+  to a JSON file for backup or server migration.
+- Added `import_settings` management command — imports from an `export_settings` file;
+  applies only fields present in the file, reports per-field changes, supports `--dry-run`.
+- Updated server-settings docs: removed stale "Visible in favicon" row, updated env badge
+  colour description, added Backup and Migration section.
+
+## 2026.05.31.01
+
+- Initial release. Provides the `ServerSettings` singleton model for instance-specific
+  configuration: server title, environment label, and language chooser settings.
+- Settings survive theme changes and are independent of the active theme.
+- Title is pre-populated from `SERVER_NAME` in `.env` on first `migrate` if blank.
+- Context processor `ophix_admin_settings.context_processors.settings_context` injects
+  `server_settings` into every admin template context via the `CONTEXT_PROCESSORS_APPEND`
+  plugin mechanism (requires `ophix-server-base>=2026.05.31.01`).

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/__init__.py

@@ -0,0 +1,4 @@
+plugin_category = "core"
+plugin_sort = 30
+
+default_app_config = "ophix_admin_settings.apps.OphixAdminSettingsConfig"

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/_version.py

@@ -0,0 +1,2 @@
+__version__ = "2026.10.04.01"
+__package_name__ = "ophix-admin-settings"

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/admin.py

@@ -0,0 +1,101 @@
+from django.conf import settings
+from django.contrib import admin, messages
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+from .models import ServerSettings
+
+
+@admin.register(ServerSettings)
+class ServerSettingsAdmin(admin.ModelAdmin):
+
+    def response_change(self, request, obj):
+        if "_save" in request.POST:
+            self.message_user(request, _("Server Settings saved successfully."), messages.SUCCESS)
+            return HttpResponseRedirect(reverse("admin:index"))
+        if "_continue" in request.POST:
+            self.message_user(request, _("Server Settings saved successfully."), messages.SUCCESS)
+            return HttpResponseRedirect(request.path)
+        return super().response_change(request, obj)
+    fieldsets = (
+        (
+            _("Server Identity"),
+            {
+                "classes": ("wide",),
+                "fields": ("title", "title_visible"),
+            },
+        ),
+        (
+            _("Environment"),
+            {
+                "classes": ("wide",),
+                "fields": (
+                    "env_name",
+                    "env_visible_in_header",
+                    ("env_color", "env_color_dark_use", "env_color_dark"),
+                    ("env_text_color", "env_text_color_dark_use", "env_text_color_dark"),
+                ),
+                "description": _(
+                    "Small badge displayed in the header to identify the deployment environment "
+                    "(e.g. PROD, DEV, TEST)."
+                ),
+            },
+        ),
+        (
+            _("Notifications"),
+            {
+                "classes": ("wide",),
+                "fields": ("message_autohide_enabled", "message_autohide_delay"),
+                "description": _(
+                    "Configure automatic dismissal of system notifications. "
+                    "Only success and info notifications are auto-dismissed; errors and warnings remain until page reload or user dismissal."
+                ),
+            },
+        ),
+        (
+            _("Language Chooser"),
+            {
+                "classes": ("wide",),
+                "fields": (
+                    "language_chooser_active",
+                    "language_chooser_control",
+                    "language_chooser_display",
+                ),
+            },
+        ),
+    )
+
+    save_on_top = True
+
+    def change_view(self, request, object_id, form_url="", extra_context=None):
+        extra_context = extra_context or {}
+        from django.conf import settings as django_settings
+        if getattr(django_settings, "SHOW_THEME_MODEL", True):
+            try:
+                from admin_interface.models import Theme
+                extra_context["active_theme"] = Theme.objects.get_active()
+            except Exception:
+                extra_context["active_theme"] = None
+        else:
+            extra_context["active_theme"] = None
+        return super().change_view(request, object_id, form_url, extra_context)
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def changelist_view(self, request, extra_context=None):
+        obj = ServerSettings.load()
+        return HttpResponseRedirect(
+            reverse("admin:ophix_admin_settings_serversettings_change", args=[obj.pk])
+        )
+
+
+if not getattr(settings, "SHOW_SETTINGS_MODEL", False):
+    try:
+        admin.site.unregister(ServerSettings)
+    except admin.sites.NotRegistered:
+        pass

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/apps.py

@@ -0,0 +1,25 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class OphixAdminSettingsConfig(AppConfig):
+    name = "ophix_admin_settings"
+    verbose_name = _("Settings")
+    admin_order = 810
+    default_auto_field = "django.db.models.AutoField"
+
+    def ready(self):
+        from django.db.models.signals import post_migrate
+        post_migrate.connect(_init_server_settings, sender=self)
+
+
+def _init_server_settings(sender, **kwargs):
+    from django.apps import apps
+    from django.conf import settings
+
+    ServerSettings = apps.get_model("ophix_admin_settings", "ServerSettings")
+    obj = ServerSettings.load()
+    if not obj.title:
+        server_name = getattr(settings, "SERVER_NAME", "").strip()
+        obj.title = ("Ophix " + server_name).strip() if server_name else "Ophix"
+        obj.save(update_fields=["title"])

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/context_processors.py

@@ -0,0 +1,3 @@
+def settings_context(request):
+    from .models import ServerSettings
+    return {"server_settings": ServerSettings.load()}

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/deploy_templates/env.fragment.j2

@@ -0,0 +1,2 @@
+# ophix-admin-settings
+SHOW_SETTINGS_MODEL=True

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/docs/sections.yaml

@@ -0,0 +1,3 @@
+sections:
+  - name: Extensions
+    collapsed: false

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/docs/server-settings.md

@@ -0,0 +1,80 @@
+---
+title: Server Settings
+slug: server-settings
+order: 520
+section: Extensions
+---
+
+# Server Settings
+
+**Server Settings** holds instance-specific configuration — values that identify this particular server and should survive a theme change. Switching from one theme to another does not alter any setting here.
+
+Access it via **Settings** in the admin sidebar.
+
+---
+
+## Server Identity
+
+| Setting | Description |
+| --- | --- |
+| **Title** | Displayed first in the browser tab (`TaskServer \| Page Name`) and in the admin header. Pre-populated from `SERVER_NAME` in `.env` on first install if blank. |
+| **Title visible** | Whether the title text appears in the admin header alongside the logo. |
+
+---
+
+## Environment
+
+A short label that identifies the deployment environment. Useful when multiple instances of the same domain are running (e.g. production, staging, and dev).
+
+| Setting | Description |
+| --- | --- |
+| **Environment name** | The label text, e.g. `Production`, `Staging`, `Dev`. |
+| **Visible in header** | Show or hide the environment badge in the page header. |
+| **Badge color** | Background colour of the environment badge (light and optional dark variant). |
+| **Badge text color** | Text colour of the environment badge (light and optional dark variant). |
+
+---
+
+## Language Chooser
+
+Controls whether operators can switch the admin UI language from the page header.
+
+| Setting | Description |
+| --- | --- |
+| **Active** | Show or hide the language chooser in the header. |
+| **Control** | Dropdown style: Default Select or Minimal Select. |
+| **Display** | Show language as its two-letter code (e.g. `EN`) or full name (e.g. `English`). |
+
+The language chooser only appears when `USE_I18N = True`, at least two languages are configured in `LANGUAGES`, and `LocaleMiddleware` is active.
+
+---
+
+## Backup and Migration
+
+`export_settings` and `import_settings` let you preserve and restore the ServerSettings singleton — useful when migrating to a new server or cloning a staging environment.
+
+**Export:**
+
+```bash
+ophix-manage export_settings --output-file settings.json
+```
+
+**Preview current values without writing:**
+
+```bash
+ophix-manage export_settings --output-file settings.json --dry-run
+```
+
+**Import (applies all fields from the file):**
+
+```bash
+ophix-manage import_settings --input-file settings.json
+```
+
+**Preview what would change:**
+
+```bash
+ophix-manage import_settings --input-file settings.json --dry-run
+```
+
+Import is safe to re-run — fields that already match the current values are reported as unchanged. Fields present in the file but absent from the model are ignored with a warning; fields absent from the file are left at their current values.

ophix_admin_settings-2026.10.4.1/src/ophix_admin_settings/management/commands/export_settings.py

@@ -0,0 +1,121 @@
+"""
+ophix-manage export_settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Export the ServerSettings singleton to a JSON file for backup or server migration.
+
+No passphrase option is provided: ServerSettings contains no sensitive data
+(title, environment badge, language chooser). Protect the file with filesystem
+permissions as you would any configuration file.
+
+Examples
+--------
+Export settings:
+    ophix-manage export_settings --output-file settings.json
+
+Preview (shows current values without writing):
+    ophix-manage export_settings --output-file settings.json --dry-run
+"""
+
+import json
+from pathlib import Path
+
+from django.core.management.base import BaseCommand, CommandError
+
+
+def _build_meta(command: str) -> dict:
+    import datetime
+    import os
+    import socket
+
+    try:
+        import pwd
+        run_by = pwd.getpwuid(os.getuid()).pw_name
+    except Exception:
+        run_by = os.environ.get("USER") or os.environ.get("LOGNAME")
+
+    from django.conf import settings
+    ssh_raw = os.environ.get("SSH_CLIENT", "")
+    return {
+        "created_at":     datetime.datetime.now(datetime.timezone.utc).isoformat(),
+        "server_name":    getattr(settings, "SERVER_NAME", None),
+        "server_version": getattr(settings, "SERVER_VERSION", None),
+        "hostname":       socket.gethostname(),
+        "command":        command,
+        "run_by":         run_by,
+        "login_user":     os.environ.get("SUDO_USER") or None,
+        "ssh_origin":     ssh_raw.split()[0] if ssh_raw else None,
+    }
+
+
+def _serialize(obj) -> dict:
+    return {
+        "title":                    obj.title,
+        "title_visible":            obj.title_visible,
+        "env_name":                 obj.env_name,
+        "env_visible_in_header":    obj.env_visible_in_header,
+        "env_color":                obj.env_color,
+        "env_color_dark_use":       obj.env_color_dark_use,
+        "env_color_dark":           obj.env_color_dark,
+        "env_text_color":           obj.env_text_color,
+        "env_text_color_dark_use":  obj.env_text_color_dark_use,
+        "env_text_color_dark":      obj.env_text_color_dark,
+        "language_chooser_active":  obj.language_chooser_active,
+        "language_chooser_control": obj.language_chooser_control,
+        "language_chooser_display": obj.language_chooser_display,
+    }
+
+
+class Command(BaseCommand):
+    help = "Export the ServerSettings singleton to a JSON file for backup or server migration."
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--output-file",
+            required=True,
+            metavar="FILE",
+            help="Destination file path.",
+        )
+        parser.add_argument(
+            "--dry-run",
+            action="store_true",
+            help="Print the values that would be exported without writing the file.",
+        )
+        parser.add_argument(
+            "--quiet",
+            action="store_true",
+            help="Suppress all output.",
+        )
+
+    def handle(self, *args, **options):
+        from ophix_admin_settings.models import ServerSettings
+
+        output_path = Path(options["output_file"])
+        dry_run     = options["dry_run"]
+        quiet       = options["quiet"]
+
+        obj = ServerSettings.load()
+        data = _serialize(obj)
+
+        if dry_run:
+            if not quiet:
+                self.stdout.write("Dry run — current ServerSettings values:")
+                for field, value in data.items():
+                    self.stdout.write(f"  {field}: {value!r}")
+            return
+
+        if not output_path.parent.exists():
+            raise CommandError(f"Output directory does not exist: {output_path.parent}")
+
+        payload = {
+            "version":  1,
+            "meta":     _build_meta("export_settings"),
+            "settings": data,
+        }
+
+        with output_path.open("w", encoding="utf-8") as f:
+            json.dump(payload, f, indent=2)
+
+        if not quiet:
+            self.stdout.write(self.style.SUCCESS(
+                f"ServerSettings exported to {output_path}."
+            ))