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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.7.tar.gz
Algorithm Hash digest
SHA256 a2b5f2d31ba0aee8b112fa6d737a51db2017b06e724c60462e141ce688e0a0cb
MD5 4447806e0ccd7459127dc1e1be5d8fdb
BLAKE2b-256 1bafcd1e52dbd4a266233010736bc38b293a6d5a0935212f21a4bf85daea537d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4f25f5343167561ac65c0a8d7748f32ed6b958b92cc86df418e95880cf37f9d3
MD5 54962028d9d157d7d1b1f86b74f8b942
BLAKE2b-256 691a12d716e448792b1107f1603a677221f1494aae7d6a85fbff115fd6189f0a

See more details on using hashes here.

Provenance

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