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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.15.tar.gz
Algorithm Hash digest
SHA256 8df7d5310f54cc83c94a4080f25f5cd0dd8d3175087df98ef1ecc7d0530be490
MD5 97674b561678aa613010f11d68b61b73
BLAKE2b-256 9ec47b73c8bad39ffcce979f7e537ff5aeb6182ce29f424e45a5b35d691eeda0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 31918aef23d5fe3df38748cbeba1d47b1329b93597de20d53a93a03f72509f5b
MD5 694df0b120f8b8e0c6f08701e1e6bf10
BLAKE2b-256 dc923b2cb5df6823a9386cb78c5104edb9995505f85471b31bcee5d5e57dcb7d

See more details on using hashes here.

Provenance

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