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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.17.tar.gz
Algorithm Hash digest
SHA256 718927776d7d5f8636b68488901d524f32a2e582ce4c1f2e641611f843762fba
MD5 cec73f2f841f5099b1312fdc46a5780d
BLAKE2b-256 e779b9abb0873ff8edaa348a1d33f27a4f32e6ceb782abf2fc87efe41470795f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 6c59aeda03c047df6df26237c40a9e5f2e9de11be1cb9cc81719d8e996d0308c
MD5 f81e1562389f65c32367f85dbb9565e5
BLAKE2b-256 0c121d40adeff00efec2b65def69dfef9e193da81a5dc9c88a480a374ce278a3

See more details on using hashes here.

Provenance

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