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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.5.tar.gz
Algorithm Hash digest
SHA256 54707be9a209dcaa70fb4d70d132bb06875f40be2e97c3601cefd0b8b45c8541
MD5 f2eaa50cba7ddeff3cfcb7e01383d681
BLAKE2b-256 246ac38988c78940594886fb48933073017411e296a4f74b3e06463673d7c4f4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4b54a8df910ed2f7d32b191a17a06a84bcab8ecc5b7f036981ae6dd3372d8bdd
MD5 04345f652fd17eadcfd38907bd40896f
BLAKE2b-256 7f52afd30a9440612ceddf33e84053532fb380e64822c2435046fc3c8da17f5c

See more details on using hashes here.

Provenance

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