Skip to main content

simple_module_settings

Runtime settings UI for simple_module apps. Other modules plug their own settings panels into a shared admin view — one page per module tab — without the host having to know about them.

Install

pip install simple_module_settings

What it provides

  • /settings admin page (and /settings/modules) aggregating every installed module's settings into one editable view.
  • register_module_settings(app, package, SettingsClass, services_factory) helper — a module calls this from its own register_settings(app) hook to record its BaseSettings class; the UI renders its fields automatically (no panel/page wiring needed).
  • DB-backed runtime settings store (hydrated into each module's BaseSettings at startup, before module on_startup hooks run) for values admins change at runtime.

Usage

Register a module's settings from its register_settings(app) hook:

from fastapi import FastAPI


class OrdersModule(ModuleBase):
    meta = ModuleMeta(name="orders")

    def register_settings(self, app: FastAPI) -> None:
        from settings.registration import register_module_settings
        from orders.settings import OrdersSettings
        from orders.services import OrdersServices

        register_module_settings(
            app, "orders", OrdersSettings, lambda s: OrdersServices(settings=s)
        )

That surfaces the module's settings fields under /settings/modules, hydrated from the DB store at startup. The settings class is a pydantic_settings.BaseSettings with the module's SM_<PREFIX>_* env-var defaults.

Depends on

  • simple_module_core, simple_module_db, simple_module_hosting

License

MIT — see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_module_settings-0.0.30.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_module_settings-0.0.30-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file simple_module_settings-0.0.30.tar.gz.

File metadata

  • Download URL: simple_module_settings-0.0.30.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for simple_module_settings-0.0.30.tar.gz
Algorithm Hash digest
SHA256 7c46c1a86df0d4ede8e0db0edcc2843757b02bece70b9f1ae51cd3ce46f80cf4
MD5 04db8223ed746a3aa8a44ae6ce0fbe64
BLAKE2b-256 8fd273c5df46dc9b9ef112b7b6fcd066b125df0a862d625401197f9fd20f9a9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_settings-0.0.30.tar.gz:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simple_module_settings-0.0.30-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_settings-0.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 84267bd525ac1def7de6846a37e5b9edf7ac9635287a40d26d8bf4ae463c5c16
MD5 dcda2579f7501f5a52092a43d319d664
BLAKE2b-256 2efd62430214576be791f9ff13eb98db3a15e4d21b5e2210155ee6da22c7c04e

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_settings-0.0.30-py3-none-any.whl:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.0.33

2 files

0.0.32

2 files

0.0.31

2 files

This release

0.0.30 This release

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page