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.28.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.28-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_settings-0.0.28.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.28.tar.gz
Algorithm Hash digest
SHA256 938a5402c0e2c3c531338a341b4df69d61c543309811acf9bd9ef2e414572665
MD5 6cb9c3d3449b8b89d112cd1c4b74f355
BLAKE2b-256 ac3bdb2d4b9f70b9e8a9ba8c6a912a81cb8cb46020e4a4d4f4e13e13d7cc75fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_settings-0.0.28.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.28-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_settings-0.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 5e5bca2f032d5c4179c9e6c70955ccd255f7dde347be34113aa38790c77c6182
MD5 c95246107c1d31b4103772f0878ea2b4
BLAKE2b-256 70f80c9ced4c6b5f5c22ec763260907b7dc60e13dee57adcbe56cbe7891a78b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_settings-0.0.28-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

0.0.30

2 files

0.0.29

2 files

This release

0.0.28 This release

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