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.12.tar.gz (15.7 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.12-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.12.tar.gz
Algorithm Hash digest
SHA256 2e8ab4ee3e7dde5333d927c6077fe9441f8fe751e60fa551d045db1b62eca75a
MD5 6e0665ed7fa17784b00c6c8f78ca1ef4
BLAKE2b-256 214f0d9aae80e71d1fe613a1132ecff9859713a2fbf026709fb3e170c5dba731

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 62b573d17bae67b313c657ca0d3387647d02b086d761b7423a919f3e778216f5
MD5 26ec7d810d63b4a8ba3a4302e2ff7525
BLAKE2b-256 919d7ac300e0beb297606d0c5178ab1683141770a7c205b9128ec217c43a452b

See more details on using hashes here.

Provenance

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