splent-feature-settings 0.2.1__tar.gz

splent_feature_settings-0.2.1/MANIFEST.in

@@ -0,0 +1,8 @@
+# Compiled frontend bundles
+recursive-include src/splent_io/splent_feature_settings/assets/dist *.js *.css *.map
+
+# Jinja templates (feature views + hook fragments)
+recursive-include src/splent_io/splent_feature_settings/templates *.html
+
+# Alembic migration config and scripts
+recursive-include src/splent_io/splent_feature_settings/migrations *.py *.ini *.mako

splent_feature_settings-0.2.1/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: splent_feature_settings
+Version: 0.2.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown

splent_feature_settings-0.2.1/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=80.3.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splent_feature_settings"
+version = "0.2.1"
+readme = "README.md"
+requires-python = ">=3.13"
+
+dependencies = [
+
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["*.tests", "*.tests.*"]
+
+[tool.splent]
+cli_version = "1.11.0"
+
+# ── Feature Contract (auto-generated) ────────────────────────────────────────
+# Do not edit manually — re-run `splent feature:contract --write` to refresh.
+# Preserved across refreshes: description, category, tags, env, and
+# requires.features_manual (dependencies invisible to static analysis).
+[tool.splent.contract]
+description = "Key-value site settings storage used by theme and admin"
+archetype = "full"
+
+[tool.splent.contract.provides]
+routes     = ["/admin/settings", "/admin/settings/<feature>"]
+blueprints = []
+models     = ["Setting"]
+commands   = ["hello"]
+hooks      = ["layout.authenticated_sidebar"]
+services   = ["SettingsService"]
+signals    = []
+translations = []
+docker     = []
+
+[tool.splent.contract.requires]
+features = []
+env_vars = []
+signals  = []
+
+[tool.splent.contract.extensible]
+services  = ["SettingsService"]
+templates = ["settings/admin/feature.html", "settings/admin/index.html", "settings/index.html"]
+models    = ["Setting"]
+hooks     = ["layout.authenticated_sidebar"]
+routes    = false

splent_feature_settings-0.2.1/setup.cfg

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

splent_feature_settings-0.2.1/src/splent_feature_settings.egg-info/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: splent_feature_settings
+Version: 0.2.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown

splent_feature_settings-0.2.1/src/splent_feature_settings.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+MANIFEST.in
+pyproject.toml
+src/splent_feature_settings.egg-info/PKG-INFO
+src/splent_feature_settings.egg-info/SOURCES.txt
+src/splent_feature_settings.egg-info/dependency_links.txt
+src/splent_feature_settings.egg-info/top_level.txt
+src/splent_io/splent_feature_settings/__init__.py
+src/splent_io/splent_feature_settings/commands.py
+src/splent_io/splent_feature_settings/config.py
+src/splent_io/splent_feature_settings/forms.py
+src/splent_io/splent_feature_settings/hooks.py
+src/splent_io/splent_feature_settings/models.py
+src/splent_io/splent_feature_settings/repositories.py
+src/splent_io/splent_feature_settings/routes.py
+src/splent_io/splent_feature_settings/seeders.py
+src/splent_io/splent_feature_settings/services.py
+src/splent_io/splent_feature_settings/signals.py
+src/splent_io/splent_feature_settings/assets/dist/splent_feature_settings.bundle.js
+src/splent_io/splent_feature_settings/assets/dist/splent_feature_settings.bundle.js.map
+src/splent_io/splent_feature_settings/migrations/alembic.ini
+src/splent_io/splent_feature_settings/migrations/env.py
+src/splent_io/splent_feature_settings/migrations/script.py.mako
+src/splent_io/splent_feature_settings/migrations/versions/settings0001_initial.py
+src/splent_io/splent_feature_settings/templates/settings/index.html
+src/splent_io/splent_feature_settings/templates/settings/admin/feature.html
+src/splent_io/splent_feature_settings/templates/settings/admin/index.html

splent_feature_settings-0.2.1/src/splent_feature_settings.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

splent_feature_settings-0.2.1/src/splent_feature_settings.egg-info/top_level.txt

@@ -0,0 +1 @@
+splent_io

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/__init__.py

@@ -0,0 +1,22 @@
+from splent_framework.blueprints.base_blueprint import create_blueprint
+from splent_framework.services.service_locator import register_service, service_proxy
+
+from splent_io.splent_feature_settings.services import SettingsService
+
+settings_bp = create_blueprint(__name__)
+
+
+def init_feature(app):
+    register_service(app, "SettingsService", SettingsService)
+
+
+def inject_context_vars(app):
+    # {{ setting('key', default) }} — read a runtime, admin-editable setting,
+    # falling back to the given default. Safe to call even mid-request.
+    def setting(key, default=""):
+        try:
+            return service_proxy("SettingsService").get(key, default)
+        except Exception:
+            return default
+
+    return {"setting": setting}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/assets/dist/splent_feature_settings.bundle.js

@@ -0,0 +1,20 @@
+/******/ (() => { // webpackBootstrap
+/*!*********************************************************************************************!*\
+  !*** ../splent_feature_settings/src/splent_io/splent_feature_settings/assets/js/scripts.js ***!
+  \*********************************************************************************************/
+// Entry point for splent_feature_settings frontend assets.
+// Add your JavaScript here. Webpack compiles this into assets/dist/splent_feature_settings.bundle.js
+//
+// To load the compiled bundle in the product layout, register it in hooks.py:
+//
+//   from splent_framework.hooks.template_hooks import register_template_hook
+//   from flask import url_for
+//
+//   def settings_scripts():
+//       return '<script src="' + url_for("settings.assets", subfolder="dist", filename="splent_feature_settings.bundle.js") + '"></script>'
+//
+//   register_template_hook("layout.scripts", settings_scripts)
+
+/******/ })()
+;
+//# sourceMappingURL=splent_feature_settings.bundle.js.map

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/assets/dist/splent_feature_settings.bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splent_feature_settings.bundle.js","mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","sources":["webpack://diversolab_app/../splent_feature_settings/src/splent_io/splent_feature_settings/assets/js/scripts.js"],"sourcesContent":["// Entry point for splent_feature_settings frontend assets.\n// Add your JavaScript here. Webpack compiles this into assets/dist/splent_feature_settings.bundle.js\n//\n// To load the compiled bundle in the product layout, register it in hooks.py:\n//\n//   from splent_framework.hooks.template_hooks import register_template_hook\n//   from flask import url_for\n//\n//   def settings_scripts():\n//       return '<script src=\"' + url_for(\"settings.assets\", subfolder=\"dist\", filename=\"splent_feature_settings.bundle.js\") + '\"></script>'\n//\n//   register_template_hook(\"layout.scripts\", settings_scripts)\n"],"names":[],"sourceRoot":""}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/commands.py

@@ -0,0 +1,21 @@
+"""
+CLI commands contributed by splent_feature_settings.
+
+These commands are auto-discovered by the framework and exposed in the
+SPLENT CLI under the ``feature:settings`` group.
+
+Usage::
+
+    splent feature:settings hello
+"""
+
+import click
+
+
+@click.command("hello")
+def hello():
+    """Example command — replace with your own."""
+    click.echo("  Hello from splent_feature_settings!")
+
+
+cli_commands = [hello]

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/config.py

@@ -0,0 +1,19 @@
+"""
+settings feature configuration.
+
+Injects environment variables into Flask app.config.
+Add your feature's env vars here so the framework can track them.
+
+To regenerate from source code: splent feature:inject-config splent_feature_settings
+"""
+
+import os  # noqa: F401 — used when adding env vars below
+
+
+def inject_config(app):
+    app.config.update(
+        {
+            # Add your feature's env vars here, e.g.:
+            # "MY_VAR": os.getenv("MY_VAR", "default_value"),
+        }
+    )

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/forms.py

@@ -0,0 +1,6 @@
+from flask_wtf import FlaskForm
+from wtforms import SubmitField
+
+
+class SplentFeatureSettingsForm(FlaskForm):
+    submit = SubmitField("Save splent_feature_settings")

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/hooks.py

@@ -0,0 +1,26 @@
+"""settings injects a single "Settings" entry into the admin sidebar, which
+lists every feature that declared a settings schema (via register_settings).
+"""
+
+from flask import request, url_for
+
+from splent_framework.hooks.template_hooks import register_template_hook
+
+
+def settings_admin_link():
+    active = (
+        "active"
+        if request.endpoint and request.endpoint.startswith("settings.admin")
+        else ""
+    )
+    return (
+        f'<li class="sidebar-item {active}">'
+        f'<a class="sidebar-link" href="{url_for("settings.admin_index")}">'
+        '<i class="align-middle" data-feather="settings"></i> '
+        '<span class="align-middle">Settings</span>'
+        "</a>"
+        "</li>"
+    )
+
+
+register_template_hook("layout.authenticated_sidebar", settings_admin_link)

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/migrations/alembic.ini

@@ -0,0 +1,36 @@
+[alembic]
+script_location = migrations
+
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/migrations/env.py

@@ -0,0 +1,9 @@
+"""Alembic migration environment for splent_feature_settings."""
+
+from splent_io.splent_feature_settings import models  # noqa
+from splent_framework.migrations.feature_env import run_feature_migrations
+
+FEATURE_NAME = "splent_feature_settings"
+FEATURE_TABLES = set()
+
+run_feature_migrations(FEATURE_NAME, FEATURE_TABLES)

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/migrations/versions/settings0001_initial.py

@@ -0,0 +1,29 @@
+"""setting table (runtime key/value settings).
+
+Revision ID: settings0001
+Revises:
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+revision = "settings0001"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "setting",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("key", sa.String(length=191), nullable=False),
+        sa.Column("value", sa.Text(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_setting_key"), "setting", ["key"], unique=True)
+
+
+def downgrade():
+    op.drop_index(op.f("ix_setting_key"), table_name="setting")
+    op.drop_table("setting")

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/models.py

@@ -0,0 +1,16 @@
+from splent_framework.db import db
+
+
+class Setting(db.Model):
+    """A single runtime, admin-editable key/value setting (the WP-options
+    analogue). Features read these via SettingsService / the {{ setting() }}
+    template helper, falling back to product config and defaults."""
+
+    __tablename__ = "setting"
+
+    id = db.Column(db.Integer, primary_key=True)
+    key = db.Column(db.String(191), nullable=False, unique=True, index=True)
+    value = db.Column(db.Text, default="")
+
+    def __repr__(self):
+        return f"Setting<{self.key}>"

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/repositories.py

@@ -0,0 +1,7 @@
+from splent_io.splent_feature_settings.models import Setting
+from splent_framework.repositories.BaseRepository import BaseRepository
+
+
+class SettingsRepository(BaseRepository):
+    def __init__(self):
+        super().__init__(Setting)

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/routes.py

@@ -0,0 +1,46 @@
+"""Generic admin panels for feature settings.
+
+Any feature that declares a settings schema (via the framework's
+register_settings) gets an admin panel here automatically — one page per
+feature — that reads/writes through SettingsService. No per-feature panel code.
+"""
+
+from flask import abort, flash, redirect, render_template, request, url_for
+from flask_login import login_required
+
+from splent_io.splent_feature_settings import settings_bp
+from splent_framework.services.service_locator import service_proxy
+from splent_framework.settings.settings_schema import (
+    get_config,
+    get_schema,
+    get_schemas,
+    setting_key,
+)
+
+
+@settings_bp.route("/admin/settings", methods=["GET"])
+@login_required
+def admin_index():
+    return render_template("settings/admin/index.html", schemas=get_schemas())
+
+
+@settings_bp.route("/admin/settings/<feature>", methods=["GET", "POST"])
+@login_required
+def admin_feature(feature):
+    schema = get_schema(feature)
+    if schema is None:
+        abort(404)
+    if request.method == "POST":
+        values = {}
+        for f in schema["fields"]:
+            key = setting_key(feature, f["key"])
+            if f["type"] == "bool":
+                values[key] = "1" if f["key"] in request.form else "0"
+            else:
+                values[key] = (request.form.get(f["key"]) or "").strip()
+        service_proxy("SettingsService").set_many(values)
+        flash(f"{schema['title']} settings saved.", "success")
+        return redirect(url_for("settings.admin_feature", feature=feature))
+    return render_template(
+        "settings/admin/feature.html", schema=schema, cfg=get_config(feature)
+    )

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/seeders.py

@@ -0,0 +1,10 @@
+from splent_framework.seeders.BaseSeeder import BaseSeeder
+
+
+class SplentFeatureSettingsSeeder(BaseSeeder):
+    def run(self):
+        data = [
+            # Create any Model object you want to make seed
+        ]
+
+        self.seed(data)

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/services.py

@@ -0,0 +1,39 @@
+from splent_io.splent_feature_settings.models import Setting
+from splent_io.splent_feature_settings.repositories import SettingsRepository
+from splent_framework.db import db
+from splent_framework.services.BaseService import BaseService
+
+
+class SettingsService(BaseService):
+    """Runtime key/value settings, editable from the admin (WP-options style)."""
+
+    def __init__(self):
+        super().__init__(SettingsRepository())
+
+    def get(self, key, default=None):
+        s = Setting.query.filter_by(key=key).first()
+        if s is None or s.value in (None, ""):
+            return default
+        return s.value
+
+    def set(self, key, value):
+        s = Setting.query.filter_by(key=key).first()
+        if s is None:
+            s = Setting(key=key, value=value or "")
+            db.session.add(s)
+        else:
+            s.value = value or ""
+        db.session.commit()
+        return s
+
+    def set_many(self, mapping):
+        for key, value in mapping.items():
+            s = Setting.query.filter_by(key=key).first()
+            if s is None:
+                db.session.add(Setting(key=key, value=value or ""))
+            else:
+                s.value = value or ""
+        db.session.commit()
+
+    def all_dict(self):
+        return {s.key: s.value for s in Setting.query.all()}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/signals.py

@@ -0,0 +1,19 @@
+"""
+Signals for splent_feature_settings.
+
+Use ``define_signal`` to declare signals this feature emits.
+Use ``connect_signal`` to listen to signals from other features.
+
+Examples::
+
+    # Define a signal (this feature emits it):
+    from splent_framework.signals.signal_utils import define_signal
+    item_created = define_signal("item-created", "splent_feature_settings")
+
+    # Connect to a signal from another feature:
+    from splent_framework.signals.signal_utils import connect_signal
+
+    @connect_signal("user-registered", "splent_feature_settings")
+    def on_user_registered(sender, user, **kwargs):
+        pass
+"""

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/templates/settings/admin/feature.html

@@ -0,0 +1,58 @@
+{% extends "base_template.html" %}
+
+{% block title %}{{ schema.title }} settings{% endblock %}
+
+{% block content %}
+<div class="d-flex flex-column align-items-start gap-2 mb-4">
+    <h1 class="h3 mb-0">{{ schema.title }} <small class="text-muted">settings</small></h1>
+    <a href="{{ url_for('settings.admin_index') }}" class="btn btn-sm btn-outline-secondary">All settings</a>
+</div>
+
+{% with messages = get_flashed_messages(with_categories=true) %}
+    {% for category, message in messages %}
+        <div class="alert alert-{{ 'danger' if category == 'danger' else 'success' }} py-2">{{ message }}</div>
+    {% endfor %}
+{% endwith %}
+
+<form method="POST">
+    <div class="card">
+        <div class="card-body">
+            {% for f in schema.fields %}
+            <div class="mb-3">
+                {% if f.type == 'bool' %}
+                <div class="form-check form-switch">
+                    <input class="form-check-input" type="checkbox" role="switch"
+                           name="{{ f.key }}" id="{{ f.key }}" {% if cfg[f.key] %}checked{% endif %}>
+                    <label class="form-check-label" for="{{ f.key }}">{{ f.label }}</label>
+                </div>
+                {% elif f.type == 'select' %}
+                <label class="form-label" for="{{ f.key }}">{{ f.label }}</label>
+                <select class="form-select" name="{{ f.key }}" id="{{ f.key }}">
+                    {% for value, label in f.options %}
+                    <option value="{{ value }}" {% if cfg[f.key] == value %}selected{% endif %}>{{ label }}</option>
+                    {% endfor %}
+                </select>
+                {% elif f.type == 'color' %}
+                <label class="form-label" for="{{ f.key }}">{{ f.label }}</label>
+                <input type="color" class="form-control form-control-color"
+                       name="{{ f.key }}" id="{{ f.key }}" value="{{ cfg[f.key] }}">
+                {% elif f.type == 'int' %}
+                <label class="form-label" for="{{ f.key }}">{{ f.label }}</label>
+                <input type="number" class="form-control"
+                       name="{{ f.key }}" id="{{ f.key }}" value="{{ cfg[f.key] }}">
+                {% else %}
+                <label class="form-label" for="{{ f.key }}">{{ f.label }}</label>
+                <input type="text" class="form-control"
+                       name="{{ f.key }}" id="{{ f.key }}" value="{{ cfg[f.key] }}">
+                {% endif %}
+                {% if f.help %}<small class="text-muted d-block mt-1">{{ f.help }}</small>{% endif %}
+            </div>
+            {% endfor %}
+        </div>
+        <div class="card-footer d-flex justify-content-between align-items-center">
+            <span class="text-muted small">Changes apply immediately.</span>
+            <button class="btn btn-primary" type="submit">Save</button>
+        </div>
+    </div>
+</form>
+{% endblock %}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/templates/settings/admin/index.html

@@ -0,0 +1,25 @@
+{% extends "base_template.html" %}
+
+{% block title %}Settings{% endblock %}
+
+{% block content %}
+<h1 class="h3 mb-2">Settings</h1>
+<p class="text-muted">Configure the behaviour of installed features.</p>
+
+{% if not schemas %}
+<p class="text-muted">No configurable features installed.</p>
+{% endif %}
+
+<div class="row g-3">
+    {% for s in schemas %}
+    <div class="col-md-4 col-sm-6">
+        <a class="card text-decoration-none h-100" href="{{ url_for('settings.admin_feature', feature=s.feature) }}">
+            <div class="card-body d-flex align-items-center gap-2">
+                <i class="align-middle" data-feather="{{ s.icon }}"></i>
+                <span class="h6 mb-0">{{ s.title }}</span>
+            </div>
+        </a>
+    </div>
+    {% endfor %}
+</div>
+{% endblock %}

splent_feature_settings-0.2.1/src/splent_io/splent_feature_settings/templates/settings/index.html

@@ -0,0 +1,10 @@
+{% extends "base_template.html" %}
+
+{% block title %}Settings{% endblock %}
+
+{% block content %}
+
+{% endblock %}
+
+{% block scripts %}
+{% endblock %}