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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.3.tar.gz
Algorithm Hash digest
SHA256 0a5ada2a2e7a1276afdf4a6ed0ecccdd370e45422223e62068a2b844aaf23dc0
MD5 5cc3119fc6694d05decf3c67d0df99dc
BLAKE2b-256 ad05fb5a30a24cf3f5d4ddf9b2547951cfeb09c1cecf24944471c14f209f4046

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_permissions-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 37ecc29b9dd081e682737ea5a1943456b5a5cfca41b524e60188ef68bc958ecd
MD5 f8b714edf86a6626bbce1677a734597d
BLAKE2b-256 708e57f93f919e410b952090a0fcc4d770c53193a5f8d3e681920e5ea19617d6

See more details on using hashes here.

Provenance

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