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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.9.tar.gz
Algorithm Hash digest
SHA256 52b0d1338301683c77a17569406a065cea52558f3935ead02027658ad0d25eaa
MD5 39287d759d97a6fc1c102ae4aa2eb362
BLAKE2b-256 64338e53ab04d46ad40eb53b7a2855f0ba74166678273cdd88af8b52de1c0076

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e12f26ca7de5c30267ffcf7ba7787a9e96d8bc3c6c4b1183345e4079a32cf9c6
MD5 d86cc72355b5af8d8d87f9ad9f7211c6
BLAKE2b-256 9460bd5fd4d7362ab69dc8d5832d831675fa139824f209717e4b1177d2d33fc3

See more details on using hashes here.

Provenance

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