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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.16.tar.gz
Algorithm Hash digest
SHA256 a61a570233bb1fc4c3d0036079c2fdc857d2a7e67d1b612bc619b26dc9e14928
MD5 95c7f2a23d57f0393fb5308d13708ebd
BLAKE2b-256 ee6cb1036f2ec2abd0c68e20fba996b5b0c227ebe0ae024e0659733e57a8ad78

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 85140c415dcfc4de7fb1fc822560d0937b7f285eb5cd8428af682e0137699ac2
MD5 967bcb5537f48e2c66ff39640a37a4f1
BLAKE2b-256 c8728f85cbdb8fd3a3bd7512405cdeb17efad55303c5f8b643a7eebdd1211a1a

See more details on using hashes here.

Provenance

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