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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1af959cb4d485afdcc3cf7095878f3f379edaa00b6a2521581163392f8174518
MD5 59fb724ec834fc1448cdb7e7f7e10f9a
BLAKE2b-256 31e47392cb840a265f28d8cc2b4bd97b56897cb97be5ef1eb2dd01be6829cca0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a432a597ef14d739755bcba6790fd53e837857356a02f5e6e6d47d6baa1d6373
MD5 19b128ff5b3a44c554f5fe41ec4e731f
BLAKE2b-256 257c96176c4c2e9aede5a155c7dc8c03969572663c56fc539a1e26b80be6a68e

See more details on using hashes here.

Provenance

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