semvec/pypi-packages huggingface dataset:
scutum 0.2.0
Framework-agnostic authorization gates inspired by Laravel
License: MIT
Requires Python: >=3.10
Keywords: acl, authorization, fastapi, flask, permissions, rbac

# Scutum

Scutum is a lightweight authorization library inspired by Laravel's Policies and Gates. It provides an easy way to manage permissions using decorators, making access control more structured and maintainable.

## Installation

```sh
pip install scutum
```

## Usage

### Defining Actions

An action is a set of rules that determine whether a user can manipulate a particular resource.

```python
from scutum import gate

@gate.register("edit")
def edit_post(user, post):
    return user.id == post.author_id
```

### Defining Policies

A policy is a named class whose methods are actions that will be registered along with the class name.

```python
from scutum import Policy, gate

@gate.policy("user")
class UserPolicy(Policy):
    def create(self, user, *args, **kwargs):
        return user.is_admin
```

### Checking Permissions

Through the gate it is possible to check the permissions of registered policies.

```python
from scutum import Policy, gate

@gate.policy("user")
class UserPolicy(Policy):
    def create(self, user, *args, **kwargs):
        return user.is_admin

    def delete(self, user, *args, **kwargs):
        return user.is_admin

def create_user():
    user = current_user()

    if gate.allowed("user:create", user): # If action is allowed
        return "You are authorized to create a user"

    if gate.denied("user:create", user): # If action is denied
        return "You are not authorized to create a user"

    if gate.any(["user:create", "user:delete"], user): # If any action
        return "You have permission to create or delete a user."

    if gate.none(["user:create", "user:delete"], user): # If none action
        return "You do not have permission to create or delete a user."

    response = gate.check("user:create", user) # bool or Response
    
    return response
```

### Responses

Responses are classes that can be returned within an action or policy for an allowed or denied action and can define details such as status code and response body.

```python
from scutum import Response, gate

@guard.register("update")
def update_user(authenticated_user, user):
    if authenticated_user.is_admin:
        return Response.allow("User authorized")

    return Response.deny("This action is not authorized")
```

## Extensions

You can explore example projects demonstrating how to integrate this library with popular Python web frameworks:

* **Flask Example**: [github.com/jigordev/flask-scutum-example](https://github.com/jigordev/flask-scutum-example)
* **FastAPI Example**: [github.com/jigordev/fastapi-scutum-example](https://github.com/jigordev/fastapi-scutum-example)

## License

MIT License