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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.4.tar.gz
Algorithm Hash digest
SHA256 00ed1954bf6de0814931f6a9f54e1a8b299ed6cf2a68a63b8165286956857e1f
MD5 d0ac8067b5d582060085b4dc5354e8d7
BLAKE2b-256 f1959a2d693ae179b621c34eec794a6e577107332361090b1ab88ba4efa39718

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 404a4f64905b0c1400d5d72f07596e1efbab5d28fd351a0663e3c0f913ab3bba
MD5 43f8e828827a7ab2175eabc6584eeb4f
BLAKE2b-256 e9712946d74e8c8f70204c57f6c4721f9c1c99beaac65ac83257dc995efccb95

See more details on using hashes here.

Provenance

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