Skip to main content

Runtime settings UI — modules plug their own settings panels into a shared admin view

Project description

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 aggregating every installed module's settings panel.
  • register_settings_panel() hook — a module declares {title, inertia_page, requires_permission}; simple_module_settings renders the tab.
  • DB-backed runtime settings table (separate from env-var-driven SM_* settings) for values admins change at runtime.

Usage

Register a panel:

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

    def register_settings_panel(self):
        return {
            "title": "Orders",
            "inertia_page": "Orders/SettingsPanel",
            "requires_permission": "orders.manage",
        }

That adds an Orders tab at /settings. The rendered page is a regular Inertia page authored inside the orders module.

Depends on

  • simple_module_core, simple_module_db, simple_module_hosting

License

MIT — see LICENSE.

Project details


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.1.tar.gz (33.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.1-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_settings-0.0.1.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for simple_module_settings-0.0.1.tar.gz
Algorithm Hash digest
SHA256 d545f4280dca4df3c92678bd74a48b2b42a1020c5c99b56900a9ce261b26c305
MD5 93d987ab5279620db82523ac3bcdf1ba
BLAKE2b-256 c8a7920d08b3b0bb21f2a2959c5d8923dbf9519f2c16b5cbf394dd63ff41270d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_settings-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24c49b8c26f90e4cc5060150f477c30ff6ad5a7e4c457abec44360f66704af99
MD5 3271bf1524cbe4f81a542c1086f8cb17
BLAKE2b-256 71e8e85382385d065842439dfac3b85c725bd525c7268efaf265e8cebaafe95d

See more details on using hashes here.

Provenance

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page