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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.10.tar.gz
Algorithm Hash digest
SHA256 bd9eef2fc9a984a877d479e5c4e27fa06036d220a9b03a19d6ffb97d8e257092
MD5 2aca0361fee11dd3d792fd101eafd3c5
BLAKE2b-256 1be7cee48b84c071cc345171365fff0db59ff1b0275cbd8c4f9549d28c917a87

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 117ead20a467a943a3792360655b04a8506629338b85a279211555a320009ff9
MD5 076de77d59c69c66e3a34cc406178781
BLAKE2b-256 7a45afc8c8eb2e594c9a6f9a55864e786a8f465f5e8600816e7afad5c3d04658

See more details on using hashes here.

Provenance

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