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.2.tar.gz (14.8 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.2-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2e1f52ff1f4dced4eed93f963e4238d98820b2a5b23e2566fffa46494240ec8c
MD5 d478ec92f6cdce473535b072f8587750
BLAKE2b-256 8e5567088248c813397cee32dacb568d1b222c7a4ed052949a61dbbef3c2a960

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8bcc908608cb44dbfb7a999f0c9a822d5686d6f7d8a6809c5d76a8257b8318ff
MD5 7d7ffee01ed523948dc7b4b4ba0cc0ae
BLAKE2b-256 1b7dd3240e6e6a81ee70ff9627d64fc32519cff5d2dc8591ca7a4544aa3423b0

See more details on using hashes here.

Provenance

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