plain.auth 0.20.0__tar.gz → 0.20.1__tar.gz

{plain_auth-0.20.0 → plain_auth-0.20.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.auth
-Version: 0.20.0
+Version: 0.20.1
 Summary: Add users to your app and decide what they can access.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -29,8 +29,11 @@ The `plain.auth` package provides user authentication and authorization for Plai
 
 ```python
 # In a view
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -45,7 +48,7 @@ class ProfileView(AuthViewMixin, View):
     login_required = True
 
     def get(self):
-        return f"Welcome, {self.request.user.email}!"
+        return f"Welcome, {self.user.email}!"
 ```
 
 ## Authentication setup
@@ -120,23 +123,24 @@ urlpatterns = [
 
 ## Checking if a user is logged in
 
-A `request.user` will either be `None` or point to an instance of your `AUTH_USER_MODEL`.
-
-In templates:
+In templates, use the `get_current_user()` function:
 
 ```html
-{% if request.user %}
-    <p>Hello, {{ request.user.email }}!</p>
+{% if get_current_user() %}
+    <p>Hello, {{ get_current_user().email }}!</p>
 {% else %}
     <p>You are not logged in.</p>
 {% endif %}
 ```
 
-In Python code:
+In Python code, use `get_request_user()`:
 
 ```python
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -163,7 +167,7 @@ class AdminOnlyView(AuthViewMixin, View):
 class CustomPermissionView(AuthViewMixin, View):
     def check_auth(self):
         super().check_auth()
-        if not self.request.user.is_special:
+        if not self.user.is_special:
             raise PermissionDenied("You're not special!")
 ```
 

{plain_auth-0.20.0 → plain_auth-0.20.1}/plain/auth/CHANGELOG.md

@@ -1,5 +1,15 @@
 # plain-auth changelog
 
+## [0.20.1](https://github.com/dropseed/plain/releases/plain-auth@0.20.1) (2025-10-02)
+
+### What's changed
+
+- Updated README documentation to use `get_request_user()` and `get_current_user()` instead of `request.user` ([f6278d9](https://github.com/dropseed/plain/commit/f6278d9bb4))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.20.0](https://github.com/dropseed/plain/releases/plain-auth@0.20.0) (2025-10-02)
 
 ### What's changed

{plain_auth-0.20.0 → plain_auth-0.20.1}/plain/auth/README.md

@@ -17,8 +17,11 @@ The `plain.auth` package provides user authentication and authorization for Plai
 
 ```python
 # In a view
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -33,7 +36,7 @@ class ProfileView(AuthViewMixin, View):
     login_required = True
 
     def get(self):
-        return f"Welcome, {self.request.user.email}!"
+        return f"Welcome, {self.user.email}!"
 ```
 
 ## Authentication setup
@@ -108,23 +111,24 @@ urlpatterns = [
 
 ## Checking if a user is logged in
 
-A `request.user` will either be `None` or point to an instance of your `AUTH_USER_MODEL`.
-
-In templates:
+In templates, use the `get_current_user()` function:
 
 ```html
-{% if request.user %}
-    <p>Hello, {{ request.user.email }}!</p>
+{% if get_current_user() %}
+    <p>Hello, {{ get_current_user().email }}!</p>
 {% else %}
     <p>You are not logged in.</p>
 {% endif %}
 ```
 
-In Python code:
+In Python code, use `get_request_user()`:
 
 ```python
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -151,7 +155,7 @@ class AdminOnlyView(AuthViewMixin, View):
 class CustomPermissionView(AuthViewMixin, View):
     def check_auth(self):
         super().check_auth()
-        if not self.request.user.is_special:
+        if not self.user.is_special:
             raise PermissionDenied("You're not special!")
 ```
 

{plain_auth-0.20.0 → plain_auth-0.20.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.auth"
-version = "0.20.0"
+version = "0.20.1"
 description = "Add users to your app and decide what they can access."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"