Skip to main content

RBAC primitives — roles, permissions, @require_permission decorator, admin UI for simple_module

Project description

simple_module_permissions

Role-based access control (RBAC) for simple_module apps. Users get roles, roles carry permissions, and route handlers declare required permissions at the decorator or dependency layer.

Pre-wired into any app scaffolded with simple-module new.

Install

pip install simple_module_permissions

What it provides

  • Role and Permission SQLModel tables, seeded from module-registered defaults.
  • @require_permission("orders.read") route decorator and HasPermission("...") dependency.
  • Admin UI at /permissions/admin for assigning roles to users.
  • register_permissions() hook — every module declares its permission strings at boot, the registry dedupes and persists them.

Usage

Declare permissions at module boot:

# modules/orders/orders/module.py
class OrdersModule(ModuleBase):
    meta = ModuleMeta(name="orders")

    def register_permissions(self):
        return ["orders.read", "orders.write"]

Guard a route:

from fastapi import APIRouter, Depends
from permissions.deps import HasPermission   # type: ignore[import-not-found]

router = APIRouter()


@router.get("/orders", dependencies=[Depends(HasPermission("orders.read"))])
async def list_orders(): ...

Admin flow: navigate to /permissions/admin, create a role, assign permissions, assign the role to users.

Depends on

  • simple_module_core, simple_module_db, simple_module_hosting, simple_module_users

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_permissions-0.0.11.tar.gz (15.7 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_permissions-0.0.11-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file simple_module_permissions-0.0.11.tar.gz.

File metadata

File hashes

Hashes for simple_module_permissions-0.0.11.tar.gz
Algorithm Hash digest
SHA256 076dbdb53a256cf83ea1cee36b7dc7d1c5c949c645220fff178f5269d089b79a
MD5 f43e3bc1ef87497b2c81c2acba0f3d9c
BLAKE2b-256 f3646d03c6329970552579d4c6c47f639215613ee27537f5dff5df11df00ffbc

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_permissions-0.0.11.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_permissions-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_permissions-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 a56bcf2e0bb92ee215f457524b4180dbc57734d034a6337952d4626677311628
MD5 0ba244e7d635357c440b32292708476b
BLAKE2b-256 633af4862a0378a89b77f7e3e54199b71930bb785c29ed05ee81b1d0f8024e95

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_permissions-0.0.11-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