prune_captcha 1.8.0__tar.gz → 1.10.0__tar.gz

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.8.0
+Version: 1.10.0
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -61,81 +61,94 @@ Don't hesitate to regularly run `poetry update`, as the captcha evolves with tim
 In `settings.py`, set the path to the images used for the puzzle:
 
 ```python
-PUZZLE_IMAGE_STATIC_PATH = "website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_and_get_puzzle to generate the captcha data.
+    -   Use create_and_get_puzzle to generate the captcha data:
 
-    -   Passes the data into the context under the puzzle variable.
+        ```python
+        from captcha_prune.utils import create_and_get_puzzle
+        ```
 
-    -   Include the component in your template:
+        ```python
+        puzzle = create_and_get_puzzle(request)
+        ```
+
+    -   Passes the data into the context under the puzzle variable:
 
         ```python
-        from captcha_prune.utils import create_and_get_puzzle
+        return render(
+            request,
+            "website/pages/contact/page.html",
+            {"form": form, "puzzle": puzzle},
+        )
         ```
 
+    -   Include the component in your template:
+
         ```
         {% include "captcha_prune/captcha.html" %}
         ```
 
 -   POST request (form submission)
 
-        -   Use verify_captcha to validate the captcha.
+        -   Use verify_captcha to validate the captcha:
 
             ```python
             from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            verify_captcha(request, redirect("/"), redirect("website:contact-page"), form)
+            response = verify_captcha(
+                request, redirect("/"), redirect("website:contact-page"), form
+            )
             ```
 
-        -   No feedback if the captcha is correct.
+        -   None if the captcha is correct.
 
-        -   Redirects in case of expired session or incorrect captcha.
+        -   Redirects in case of expired session or incorrect captcha:
+
+            ```python
+            if response is not None:
+                return response
+            ```
 
 ### Example
 
     ```python
-    from django.shortcuts import render, redirect
-
-    from django.contrib import messages
-    from captcha_prune.utils import create_and_get_puzzle, verify_captcha
-    from .forms import ContactForm
-
     def contact_view(request):
         if request.method == "POST":
             form = ContactForm(request.POST)
             if form.is_valid():
-                verify_captcha(
-                    request,
-                    redirect("/"),
-                    redirect("website:contact-page"),
-                    form
+                response = verify_captcha(
+                    request, redirect("/"), redirect("website:contact-page"), form
                 )
-                messages.success(request, "Formulaire soumis avec succès.")
-                return redirect("/")
-            else:
-                puzzle = create_and_get_puzzle(request)
+            if response is not None:
+                return response
+            messages.success(request, "Formulaire soumis avec succès.")
+            return redirect("/")
         else:
-            form = ContactForm()
             puzzle = create_and_get_puzzle(request)
+    else:
+        form = ContactForm()
+        puzzle = create_and_get_puzzle(request)
     return render(
         request,
         "website/pages/contact/page.html",
         {"form": form, "puzzle": puzzle},
     )
-
-```
+    ```
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
+| 1.9.0   | 2025-05-20 | puzzle images path fixed           |
 | 1.8.0   | 2025-05-20 | added migrations                   |
 | 1.7.0   | 2025-05-20 | PUZZLE_IMAGE_STATIC_PATH ...       |
 | 1.6.0   | 2025-05-20 | added templates                    |
@@ -145,4 +158,3 @@ PUZZLE_IMAGE_STATIC_PATH = "website/images/"
 | 1.2.0   | 2025-04-30 | fixed prune_captcha command, ...   |
 | 1.1.0   | 2025-04-30 | start_server was not a module, ... |
 | 1.0.0   | 2025-04-29 | First version of the `captcha` ... |
-```

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/README.md

@@ -43,81 +43,94 @@ Don't hesitate to regularly run `poetry update`, as the captcha evolves with tim
 In `settings.py`, set the path to the images used for the puzzle:
 
 ```python
-PUZZLE_IMAGE_STATIC_PATH = "website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_and_get_puzzle to generate the captcha data.
+    -   Use create_and_get_puzzle to generate the captcha data:
 
-    -   Passes the data into the context under the puzzle variable.
+        ```python
+        from captcha_prune.utils import create_and_get_puzzle
+        ```
 
-    -   Include the component in your template:
+        ```python
+        puzzle = create_and_get_puzzle(request)
+        ```
+
+    -   Passes the data into the context under the puzzle variable:
 
         ```python
-        from captcha_prune.utils import create_and_get_puzzle
+        return render(
+            request,
+            "website/pages/contact/page.html",
+            {"form": form, "puzzle": puzzle},
+        )
         ```
 
+    -   Include the component in your template:
+
         ```
         {% include "captcha_prune/captcha.html" %}
         ```
 
 -   POST request (form submission)
 
-        -   Use verify_captcha to validate the captcha.
+        -   Use verify_captcha to validate the captcha:
 
             ```python
             from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            verify_captcha(request, redirect("/"), redirect("website:contact-page"), form)
+            response = verify_captcha(
+                request, redirect("/"), redirect("website:contact-page"), form
+            )
             ```
 
-        -   No feedback if the captcha is correct.
+        -   None if the captcha is correct.
 
-        -   Redirects in case of expired session or incorrect captcha.
+        -   Redirects in case of expired session or incorrect captcha:
+
+            ```python
+            if response is not None:
+                return response
+            ```
 
 ### Example
 
     ```python
-    from django.shortcuts import render, redirect
-
-    from django.contrib import messages
-    from captcha_prune.utils import create_and_get_puzzle, verify_captcha
-    from .forms import ContactForm
-
     def contact_view(request):
         if request.method == "POST":
             form = ContactForm(request.POST)
             if form.is_valid():
-                verify_captcha(
-                    request,
-                    redirect("/"),
-                    redirect("website:contact-page"),
-                    form
+                response = verify_captcha(
+                    request, redirect("/"), redirect("website:contact-page"), form
                 )
-                messages.success(request, "Formulaire soumis avec succès.")
-                return redirect("/")
-            else:
-                puzzle = create_and_get_puzzle(request)
+            if response is not None:
+                return response
+            messages.success(request, "Formulaire soumis avec succès.")
+            return redirect("/")
         else:
-            form = ContactForm()
             puzzle = create_and_get_puzzle(request)
+    else:
+        form = ContactForm()
+        puzzle = create_and_get_puzzle(request)
     return render(
         request,
         "website/pages/contact/page.html",
         {"form": form, "puzzle": puzzle},
     )
-
-```
+    ```
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
+| 1.9.0   | 2025-05-20 | puzzle images path fixed           |
 | 1.8.0   | 2025-05-20 | added migrations                   |
 | 1.7.0   | 2025-05-20 | PUZZLE_IMAGE_STATIC_PATH ...       |
 | 1.6.0   | 2025-05-20 | added templates                    |
@@ -127,4 +140,3 @@ PUZZLE_IMAGE_STATIC_PATH = "website/images/"
 | 1.2.0   | 2025-04-30 | fixed prune_captcha command, ...   |
 | 1.1.0   | 2025-04-30 | start_server was not a module, ... |
 | 1.0.0   | 2025-04-29 | First version of the `captcha` ... |
-```

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/captcha_prune/utils.py

@@ -10,7 +10,7 @@ from django.urls import reverse
 
 
 def create_and_get_puzzle(request: HttpRequest) -> HttpResponse | dict:
-    puzzle_path = getattr(settings, "PUZZLE_IMAGE_STATIC_PATH", None)
+    _, _, puzzle_images_path = settings.PUZZLE_IMAGE_STATIC_PATH.rpartition("static/")
     try:
         response = requests.post(
             request.build_absolute_uri(reverse("captcha:create-captcha"))
@@ -20,7 +20,7 @@ def create_and_get_puzzle(request: HttpRequest) -> HttpResponse | dict:
     request.session["puzzle_uuid"] = response["uuid"]
     puzzle_images = [
         f
-        for f in os.listdir(puzzle_path)
+        for f in os.listdir(settings.PUZZLE_IMAGE_STATIC_PATH)
         if f.lower().endswith((".jpg", ".jpeg", ".png", ".gif"))
     ]
     selected_image = random.choice(puzzle_images)
@@ -34,7 +34,7 @@ def create_and_get_puzzle(request: HttpRequest) -> HttpResponse | dict:
         "pos_y_solution": response["pos_y_solution"],
         "piece_pos_x": response["piece_pos_x"],
         "piece_pos_y": response["piece_pos_y"],
-        "image": f"{settings.PUZZLE_IMAGE_STATIC_PATH}{selected_image}",
+        "image": f"{puzzle_images_path}{selected_image}",
     }
 
 

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/prune_captcha.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prune_captcha
-Version: 1.8.0
+Version: 1.10.0
 Summary: A tool to protect formulaire from spam.
 Author-email: Arnout <bastien@prune.sh>
 Project-URL: Made_by, https://prune.sh/
@@ -61,81 +61,94 @@ Don't hesitate to regularly run `poetry update`, as the captcha evolves with tim
 In `settings.py`, set the path to the images used for the puzzle:
 
 ```python
-PUZZLE_IMAGE_STATIC_PATH = "website/images/"
+PUZZLE_IMAGE_STATIC_PATH = "website/static/website/images/"
 ```
 
 ### Utilisation
 
 -   GET request (form display)
 
-    -   Use create_and_get_puzzle to generate the captcha data.
+    -   Use create_and_get_puzzle to generate the captcha data:
 
-    -   Passes the data into the context under the puzzle variable.
+        ```python
+        from captcha_prune.utils import create_and_get_puzzle
+        ```
 
-    -   Include the component in your template:
+        ```python
+        puzzle = create_and_get_puzzle(request)
+        ```
+
+    -   Passes the data into the context under the puzzle variable:
 
         ```python
-        from captcha_prune.utils import create_and_get_puzzle
+        return render(
+            request,
+            "website/pages/contact/page.html",
+            {"form": form, "puzzle": puzzle},
+        )
         ```
 
+    -   Include the component in your template:
+
         ```
         {% include "captcha_prune/captcha.html" %}
         ```
 
 -   POST request (form submission)
 
-        -   Use verify_captcha to validate the captcha.
+        -   Use verify_captcha to validate the captcha:
 
             ```python
             from captcha_prune.utils import verify_captcha
             ```
 
             ```python
-            verify_captcha(request, redirect("/"), redirect("website:contact-page"), form)
+            response = verify_captcha(
+                request, redirect("/"), redirect("website:contact-page"), form
+            )
             ```
 
-        -   No feedback if the captcha is correct.
+        -   None if the captcha is correct.
 
-        -   Redirects in case of expired session or incorrect captcha.
+        -   Redirects in case of expired session or incorrect captcha:
+
+            ```python
+            if response is not None:
+                return response
+            ```
 
 ### Example
 
     ```python
-    from django.shortcuts import render, redirect
-
-    from django.contrib import messages
-    from captcha_prune.utils import create_and_get_puzzle, verify_captcha
-    from .forms import ContactForm
-
     def contact_view(request):
         if request.method == "POST":
             form = ContactForm(request.POST)
             if form.is_valid():
-                verify_captcha(
-                    request,
-                    redirect("/"),
-                    redirect("website:contact-page"),
-                    form
+                response = verify_captcha(
+                    request, redirect("/"), redirect("website:contact-page"), form
                 )
-                messages.success(request, "Formulaire soumis avec succès.")
-                return redirect("/")
-            else:
-                puzzle = create_and_get_puzzle(request)
+            if response is not None:
+                return response
+            messages.success(request, "Formulaire soumis avec succès.")
+            return redirect("/")
         else:
-            form = ContactForm()
             puzzle = create_and_get_puzzle(request)
+    else:
+        form = ContactForm()
+        puzzle = create_and_get_puzzle(request)
     return render(
         request,
         "website/pages/contact/page.html",
         {"form": form, "puzzle": puzzle},
     )
-
-```
+    ```
 
 # Available Versions
 
 | Version | Date       | Notes                              |
 | ------- | ---------- | ---------------------------------- |
+| 1.10.0  | 2025-05-20 | fix documentation, removed ...     |
+| 1.9.0   | 2025-05-20 | puzzle images path fixed           |
 | 1.8.0   | 2025-05-20 | added migrations                   |
 | 1.7.0   | 2025-05-20 | PUZZLE_IMAGE_STATIC_PATH ...       |
 | 1.6.0   | 2025-05-20 | added templates                    |
@@ -145,4 +158,3 @@ PUZZLE_IMAGE_STATIC_PATH = "website/images/"
 | 1.2.0   | 2025-04-30 | fixed prune_captcha command, ...   |
 | 1.1.0   | 2025-04-30 | start_server was not a module, ... |
 | 1.0.0   | 2025-04-29 | First version of the `captcha` ... |
-```

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/prune_captcha.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ pyproject.toml
 captcha_prune/__init__.py
 captcha_prune/apps.py
 captcha_prune/asgi.py
-captcha_prune/context_processors.py
 captcha_prune/models.py
 captcha_prune/payloads.py
 captcha_prune/settings.py

{prune_captcha-1.8.0 → prune_captcha-1.10.0}/pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
 keywords = ["captcha", "django", "code-quality"]
 urls = {Made_by = "https://prune.sh/"}
 name = "prune_captcha"
-version = "1.8.0"
+version = "1.10.0"
 description = "A tool to protect formulaire from spam."
 readme = "README.md"
 dependencies = [

prune_captcha-1.8.0/captcha_prune/context_processors.py

@@ -1,12 +0,0 @@
-from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
-
-
-def puzzle_static_path(request):
-    try:
-        path = settings.PUZZLE_IMAGE_STATIC_PATH
-    except AttributeError:
-        raise ImproperlyConfigured(
-            "Vous devez définir PUZZLE_IMAGE_STATIC_PATH dans votre settings.py"
-        )
-    return {"PUZZLE_IMAGE_STATIC_PATH": path}