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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.18.tar.gz
Algorithm Hash digest
SHA256 e3ef414d546e52243b87191572d71ae5d7d43f484886fa43c2eae9b7f1ae065c
MD5 9a0bd0ac8a9e26d61e58b1836036f0b3
BLAKE2b-256 243b77d65ea29527d2388765a69ce3b398ea6b62ef2feb049a0af3adc5988ce3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 a796542e93bead1b9a5889b76496f19dbca61b8ae8972e558c4e6349d6e09f9c
MD5 5f5c7360aa9fd576ea85bb43c0f08a22
BLAKE2b-256 8257ad30375456109e6956b53b6dcf944fff417cf6a51f0928e3dcdea751738e

See more details on using hashes here.

Provenance

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