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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.13.tar.gz
Algorithm Hash digest
SHA256 60a853d8d708dc4d63b32c52d81f3dcb4a0b162ec4a607606a10740ea334e1c6
MD5 5f976132140af766a657c82948747dab
BLAKE2b-256 358414f0108f7d2b9bb6b5dfadcedfeb705449da3b99096355aaf34068fe84a6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 b083e3619fadb5e15afb1680de87ca81214a531a450344cd15786d4495fb9047
MD5 93a07b9b23bad960bff7d939040d6187
BLAKE2b-256 c6371bd2df41714097d359ed7ddd6e881d5a76af289fc13d86c02461aa2baad6

See more details on using hashes here.

Provenance

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