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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.6.tar.gz
Algorithm Hash digest
SHA256 2205d8130f1aaf01ef61060d0fd55a7049c5848ac104947454fd01038539492f
MD5 3ee7ec1f35e1d8f84f9b0fe64549e216
BLAKE2b-256 f2bba3d07190514eb24a91737b93604b87d640d4dc404dd12f87af32343e5f1c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bfbce12e3a01ce588988a5e0c722ceff93f36cefb404910daac40973c12bf3fe
MD5 4f1bb806efec420388d4b9259116a66f
BLAKE2b-256 243f5daaa0695ebba97368dc1fad0f209fc25fea3b71660fea72ce46a302fe97

See more details on using hashes here.

Provenance

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