django-qstash 0.0.11__tar.gz → 0.0.12__tar.gz

{django_qstash-0.0.11 → django_qstash-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-qstash
-Version: 0.0.11
+Version: 0.0.12
 Summary: A drop-in replacement for Celery's shared_task with Upstash QStash.
 Author-email: Justin Mitchel <justin@codingforentrepreneurs.com>
 Project-URL: Changelog, https://github.com/jmitchel3/django-qstash
@@ -79,18 +79,22 @@ This allows us to:
   - [Usage](#usage)
     - [Define a Task](#define-a-task)
     - [Regular Task Call](#regular-task-call)
-    - [Async Task](#async-task)
+    - [Background Task](#background-task)
       - [`.delay()`](#delay)
       - [`.apply_async()`](#apply_async)
       - [`.apply_async()` With Time Delay](#apply_async-with-time-delay)
-    - [JSON-ready Arguments](#json-ready-arguments)
+    - [Arguments Must be JSON-ready](#arguments-must-be-json-ready)
     - [Example Task](#example-task)
   - [Management Commands](#management-commands)
-  - [Development Usage](#development-usage)
+  - [Public Domain In Development](#public-domain-in-development)
   - [Django Settings Configuration](#django-settings-configuration)
+    - [`DJANGO_QSTASH_DOMAIN`](#django_qstash_domain)
+    - [`DJANGO_QSTASH_WEBHOOK_PATH`](#django_qstash_webhook_path)
+    - [`DJANGO_QSTASH_FORCE_HTTPS`](#django_qstash_force_https)
+    - [Example Django Settings](#example-django-settings)
   - [Schedule Tasks (Optional)](#schedule-tasks-optional)
     - [Installation](#installation-1)
-  - [Schedule a Task](#schedule-a-task)
+    - [Schedule a Task](#schedule-a-task)
   - [Store Task Results (Optional)](#store-task-results-optional)
     - [Clear Stale Results](#clear-stale-results)
   - [Definitions](#definitions)
@@ -161,7 +165,7 @@ There is a sample project in [sample_project/](sample_project/) that shows how a
 
 ## Usage
 
-Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `stashed_task` decorator.
+Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `shared_task` decorator.
 
 Here's how it works:
 - Define a Task
@@ -169,6 +173,8 @@ Here's how it works:
 
 ### Define a Task
 ```python
+# from celery import shared_task
+from django_qstash import shared_task
 from django_qstash import stashed_task
 
 
@@ -178,8 +184,19 @@ def hello_world(name: str, age: int = None, activity: str = None):
         print(f"Hello {name}! I see you're {activity}.")
         return
     print(f"Hello {name}! I see you're {activity} at {age} years old.")
+
+
+@shared_task
+def hello_world_redux(name: str, age: int = None, activity: str = None):
+    if age is None:
+        print(f"Hello {name}! I see you're {activity}.")
+        return
+    print(f"Hello {name}! I see you're {activity} at {age} years old.")
 ```
 
+- `hello_world` and `hello_world_redux` work the same with django-qstash.
+- If you use Celery's `@shared_task` instead, Celery would handle only `hello_world_redux` and django-qstash would handle only `hello_world`.
+
 ### Regular Task Call
 Nothing special here. Just call the function like any other to verify it works.
 
@@ -188,9 +205,11 @@ Nothing special here. Just call the function like any other to verify it works.
 hello_world("Tony Stark", age=40, activity="building in a cave with a box of scraps.")
 ```
 
-### Async Task
+### Background Task
+
+Using `.delay()` or `.apply_async()` is how you trigger a background task. These background tasks are actually setting up a QStash message that will be delivered via webhook to your Django application. django-qstash handles the webhook and the message delivery assuming installed correctly.
 
-Using `.delay()` or `.apply_async()` is how you call an async task. This is modeled after Celery and it works as you'd expect.
+This functionality is modeled after Celery and it works as you'd expect.
 
 
 #### `.delay()`
@@ -223,10 +242,11 @@ hello_world.apply_async(
 )
 ```
 
-### JSON-ready Arguments
+### Arguments Must be JSON-ready
 
-Each argument needs to be _JSON_ serializable. The way you find out:
+Arguments to django-qstash managed functions must be _JSON_ serializable.
 
+The way you find out:
 ```python
 import json
 
@@ -237,6 +257,11 @@ data = {
 print(json.dumps(data))
 # no errors, you're good to go.
 ```
+If you have `errors` you'll need to fix them. Here's a few common errors you might see:
+
+- Using a Django queryset directly as an argument
+- Using a Django model instance directly as an argument
+- Using a datetime object directly as an argument (e.g. `datetime.datetime` or `datetime.date`) instead of a timestamp or date string (e.g. `datetime.datetime.now().timestamp()` or `datetime.datetime.now.strftime("%Y-%m-%d")`)
 
 ### Example Task
 
@@ -281,38 +306,83 @@ The `.delay()` method does not support a countdown parameter because it simply p
 
 ## Management Commands
 
-- `python manage.py available_tasks` to view all available tasks
+- `python manage.py available_tasks` to view all available tasks found by django-qstash. Unlike Celery, django-qstash does not assign tasks to a specific Celery app (e.g. `app = Celery()`).
 
 _Requires `django_qstash.schedules` installed._
 - `python manage.py task_schedules --list` see all schedules relate to the `DJANGO_QSTASH_DOMAIN`
 - `python manage.py task_schedules --sync` sync schedules based on the `DJANGO_QSTASH_DOMAIN` to store in the Django Admin.
 
-## Development Usage
+## Public Domain In Development
 
-django-qstash requires a public domain to work (e.g. `https://djangoqstash.com`). There are many ways to do this, we recommend:
+django-qstash _requires_ a publicly accessible domain to work (e.g. `https://djangoqstash.com`). There are many ways to do this, we recommend:
 
 - [Cloudflare Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) with a domain name you control.
 - [ngrok](https://ngrok.com/)
 
 Once you have a domain name, you can configure the `DJANGO_QSTASH_DOMAIN` setting in your Django settings.
 
-
 ## Django Settings Configuration
 
-In Django settings, you can configure the following:
+Various options are available to configure django-qstash.
+
+### `DJANGO_QSTASH_DOMAIN`
+- Required: Yes
+- Default:`None`
+- Description: Must be a valid and publicly accessible domain. For example `https://djangoqstash.com`. Review [Development usage](#development-usage) for setting up a domain name during development.
 
-- `DJANGO_QSTASH_DOMAIN`: Must be a valid and publicly accessible domain. For example `https://djangoqstash.com`. Review [Development usage](#development-usage) for setting up a domain name during development.
+### `DJANGO_QSTASH_WEBHOOK_PATH`
+- Required: Yes
+- Default:`/qstash/webhook/`
+- Description: The path where QStash will send webhooks to your Django application.
 
-- `DJANGO_QSTASH_WEBHOOK_PATH` (default:`/qstash/webhook/`): The path where QStash will send webhooks to your Django application.
+### `DJANGO_QSTASH_FORCE_HTTPS`
+- Required: No
+- Default: `True`
+- Description: Whether to force HTTPS for the webhook.
 
-- `DJANGO_QSTASH_FORCE_HTTPS` (default:`True`): Whether to force HTTPS for the webhook.
+###`DJANGO_QSTASH_RESULT_TTL`
+- Required: No
+- Default:`604800`
+- Description: A number of seconds after which task result data can be safely deleted. Defaults to 604800 seconds (7 days or 7 * 24 * 60 * 60).
 
-- `DJANGO_QSTASH_RESULT_TTL` (default:`604800`): A number of seconds after which task result data can be safely deleted. Defaults to 604800 seconds (7 days or 7 * 24 * 60 * 60).
+
+### Example Django Settings
+
+For a complete example, review [sample_project/settings.py](sample_project/settings.py) where [python-decouple](https://github.com/henriquebastos/python-decouple) is used to set the environment variables via the `.env` file or system environment variables (for production use).
+
+Using `os.environ`:
+```python
+import os
+
+###########################
+# django settings
+###########################
+DJANGO_DEBUG = str(os.environ.get("DJANGO_DEBUG")) == "1"
+DJANGO_SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY")
+ALLOWED_HOSTS = [os.environ.get("ALLOWED_HOST")]
+CSRF_TRUSTED_ORIGINS = [os.environ.get("CSRF_TRUSTED_ORIGIN")]
+###########################
+# qstash-py settings
+###########################
+QSTASH_TOKEN = os.environ.get("QSTASH_TOKEN")
+QSTASH_CURRENT_SIGNING_KEY = os.environ.get("QSTASH_CURRENT_SIGNING_KEY")
+QSTASH_NEXT_SIGNING_KEY = os.environ.get("QSTASH_NEXT_SIGNING_KEY")
+
+###########################
+# django_qstash settings
+###########################
+DJANGO_QSTASH_DOMAIN = os.environ.get("DJANGO_QSTASH_DOMAIN")
+DJANGO_QSTASH_WEBHOOK_PATH = os.environ.get("DJANGO_QSTASH_WEBHOOK_PATH")
+DJANGO_QSTASH_FORCE_HTTPS = True
+DJANGO_QSTASH_RESULT_TTL = 604800
+```
 
 
 ## Schedule Tasks (Optional)
 
-The `django_qstash.schedules` app schedules tasks using Upstash [QStash Schedules](https://upstash.com/docs/qstash/features/schedules) and the django-qstash `@stashed_task` decorator.
+Run background tasks on a CRON schedule.
+
+The `django_qstash.schedules` app schedules tasks using Upstash [QStash Schedules](https://upstash.com/docs/qstash/features/schedules) via `@shared_task` or `@stashed_task` decorators along with the `TaskSchedule` model.
 
 ### Installation
 
@@ -332,8 +402,7 @@ Run migrations:
 python manage.py migrate django_qstash_schedules
 ```
 
-
-## Schedule a Task
+### Schedule a Task
 
 Tasks must exist before you can schedule them. Review [Define a Task](#define-a-task) for more information.
 
@@ -341,9 +410,6 @@ Here's how you can schedule a task:
 - Django Admin (`/admin/django_qstash_schedules/taskschedule/add/`)
 - Django shell (`python manage.py shell`)
 
-
-
-
 ```python
 from django_qstash.schedules.models import TaskSchedule
 from django_qstash.discovery.utils import discover_tasks
@@ -372,10 +438,11 @@ TaskSchedule.objects.create(
 - `cron` is the cron schedule to run the task. Use [contrab.guru](https://crontab.guru/) for writing the cron format.
 
 
-
 ## Store Task Results (Optional)
 
-In `django_qstash.results.models` we have the `TaskResult` model class that can be used to track async task results. These entries are created via webhooks.
+Retain the results of background tasks in the database with clear-out functionality.
+
+In `django_qstash.results.models` we have the `TaskResult` model class that can be used to track async task results. These entries are created via the django-qstash webhook view handler (`qstash_webhook_view`).
 
 To install it, just add `django_qstash.results` to your `INSTALLED_APPS` setting.
 
@@ -393,6 +460,12 @@ Run migrations:
 python manage.py migrate django_qstash_results
 ```
 
+Key configuration:
+
+- [DJANGO_QSTASH_WEBHOOK_PATH](#django-settings-configuration)
+- [DJANGO_QSTASH_DOMAIN](#django-settings-configuration)
+- [DJANGO_QSTASH_RESULT_TTL](#django-settings-configuration)
+
 ### Clear Stale Results
 
 We recommend purging the `TaskResult` model after a certain amount of time.

{django_qstash-0.0.11 → django_qstash-0.0.12}/README.md

@@ -50,18 +50,22 @@ This allows us to:
   - [Usage](#usage)
     - [Define a Task](#define-a-task)
     - [Regular Task Call](#regular-task-call)
-    - [Async Task](#async-task)
+    - [Background Task](#background-task)
       - [`.delay()`](#delay)
       - [`.apply_async()`](#apply_async)
       - [`.apply_async()` With Time Delay](#apply_async-with-time-delay)
-    - [JSON-ready Arguments](#json-ready-arguments)
+    - [Arguments Must be JSON-ready](#arguments-must-be-json-ready)
     - [Example Task](#example-task)
   - [Management Commands](#management-commands)
-  - [Development Usage](#development-usage)
+  - [Public Domain In Development](#public-domain-in-development)
   - [Django Settings Configuration](#django-settings-configuration)
+    - [`DJANGO_QSTASH_DOMAIN`](#django_qstash_domain)
+    - [`DJANGO_QSTASH_WEBHOOK_PATH`](#django_qstash_webhook_path)
+    - [`DJANGO_QSTASH_FORCE_HTTPS`](#django_qstash_force_https)
+    - [Example Django Settings](#example-django-settings)
   - [Schedule Tasks (Optional)](#schedule-tasks-optional)
     - [Installation](#installation-1)
-  - [Schedule a Task](#schedule-a-task)
+    - [Schedule a Task](#schedule-a-task)
   - [Store Task Results (Optional)](#store-task-results-optional)
     - [Clear Stale Results](#clear-stale-results)
   - [Definitions](#definitions)
@@ -132,7 +136,7 @@ There is a sample project in [sample_project/](sample_project/) that shows how a
 
 ## Usage
 
-Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `stashed_task` decorator.
+Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `shared_task` decorator.
 
 Here's how it works:
 - Define a Task
@@ -140,6 +144,8 @@ Here's how it works:
 
 ### Define a Task
 ```python
+# from celery import shared_task
+from django_qstash import shared_task
 from django_qstash import stashed_task
 
 
@@ -149,8 +155,19 @@ def hello_world(name: str, age: int = None, activity: str = None):
         print(f"Hello {name}! I see you're {activity}.")
         return
     print(f"Hello {name}! I see you're {activity} at {age} years old.")
+
+
+@shared_task
+def hello_world_redux(name: str, age: int = None, activity: str = None):
+    if age is None:
+        print(f"Hello {name}! I see you're {activity}.")
+        return
+    print(f"Hello {name}! I see you're {activity} at {age} years old.")
 ```
 
+- `hello_world` and `hello_world_redux` work the same with django-qstash.
+- If you use Celery's `@shared_task` instead, Celery would handle only `hello_world_redux` and django-qstash would handle only `hello_world`.
+
 ### Regular Task Call
 Nothing special here. Just call the function like any other to verify it works.
 
@@ -159,9 +176,11 @@ Nothing special here. Just call the function like any other to verify it works.
 hello_world("Tony Stark", age=40, activity="building in a cave with a box of scraps.")
 ```
 
-### Async Task
+### Background Task
+
+Using `.delay()` or `.apply_async()` is how you trigger a background task. These background tasks are actually setting up a QStash message that will be delivered via webhook to your Django application. django-qstash handles the webhook and the message delivery assuming installed correctly.
 
-Using `.delay()` or `.apply_async()` is how you call an async task. This is modeled after Celery and it works as you'd expect.
+This functionality is modeled after Celery and it works as you'd expect.
 
 
 #### `.delay()`
@@ -194,10 +213,11 @@ hello_world.apply_async(
 )
 ```
 
-### JSON-ready Arguments
+### Arguments Must be JSON-ready
 
-Each argument needs to be _JSON_ serializable. The way you find out:
+Arguments to django-qstash managed functions must be _JSON_ serializable.
 
+The way you find out:
 ```python
 import json
 
@@ -208,6 +228,11 @@ data = {
 print(json.dumps(data))
 # no errors, you're good to go.
 ```
+If you have `errors` you'll need to fix them. Here's a few common errors you might see:
+
+- Using a Django queryset directly as an argument
+- Using a Django model instance directly as an argument
+- Using a datetime object directly as an argument (e.g. `datetime.datetime` or `datetime.date`) instead of a timestamp or date string (e.g. `datetime.datetime.now().timestamp()` or `datetime.datetime.now.strftime("%Y-%m-%d")`)
 
 ### Example Task
 
@@ -252,38 +277,83 @@ The `.delay()` method does not support a countdown parameter because it simply p
 
 ## Management Commands
 
-- `python manage.py available_tasks` to view all available tasks
+- `python manage.py available_tasks` to view all available tasks found by django-qstash. Unlike Celery, django-qstash does not assign tasks to a specific Celery app (e.g. `app = Celery()`).
 
 _Requires `django_qstash.schedules` installed._
 - `python manage.py task_schedules --list` see all schedules relate to the `DJANGO_QSTASH_DOMAIN`
 - `python manage.py task_schedules --sync` sync schedules based on the `DJANGO_QSTASH_DOMAIN` to store in the Django Admin.
 
-## Development Usage
+## Public Domain In Development
 
-django-qstash requires a public domain to work (e.g. `https://djangoqstash.com`). There are many ways to do this, we recommend:
+django-qstash _requires_ a publicly accessible domain to work (e.g. `https://djangoqstash.com`). There are many ways to do this, we recommend:
 
 - [Cloudflare Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) with a domain name you control.
 - [ngrok](https://ngrok.com/)
 
 Once you have a domain name, you can configure the `DJANGO_QSTASH_DOMAIN` setting in your Django settings.
 
-
 ## Django Settings Configuration
 
-In Django settings, you can configure the following:
+Various options are available to configure django-qstash.
+
+### `DJANGO_QSTASH_DOMAIN`
+- Required: Yes
+- Default:`None`
+- Description: Must be a valid and publicly accessible domain. For example `https://djangoqstash.com`. Review [Development usage](#development-usage) for setting up a domain name during development.
 
-- `DJANGO_QSTASH_DOMAIN`: Must be a valid and publicly accessible domain. For example `https://djangoqstash.com`. Review [Development usage](#development-usage) for setting up a domain name during development.
+### `DJANGO_QSTASH_WEBHOOK_PATH`
+- Required: Yes
+- Default:`/qstash/webhook/`
+- Description: The path where QStash will send webhooks to your Django application.
 
-- `DJANGO_QSTASH_WEBHOOK_PATH` (default:`/qstash/webhook/`): The path where QStash will send webhooks to your Django application.
+### `DJANGO_QSTASH_FORCE_HTTPS`
+- Required: No
+- Default: `True`
+- Description: Whether to force HTTPS for the webhook.
 
-- `DJANGO_QSTASH_FORCE_HTTPS` (default:`True`): Whether to force HTTPS for the webhook.
+###`DJANGO_QSTASH_RESULT_TTL`
+- Required: No
+- Default:`604800`
+- Description: A number of seconds after which task result data can be safely deleted. Defaults to 604800 seconds (7 days or 7 * 24 * 60 * 60).
 
-- `DJANGO_QSTASH_RESULT_TTL` (default:`604800`): A number of seconds after which task result data can be safely deleted. Defaults to 604800 seconds (7 days or 7 * 24 * 60 * 60).
+
+### Example Django Settings
+
+For a complete example, review [sample_project/settings.py](sample_project/settings.py) where [python-decouple](https://github.com/henriquebastos/python-decouple) is used to set the environment variables via the `.env` file or system environment variables (for production use).
+
+Using `os.environ`:
+```python
+import os
+
+###########################
+# django settings
+###########################
+DJANGO_DEBUG = str(os.environ.get("DJANGO_DEBUG")) == "1"
+DJANGO_SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY")
+ALLOWED_HOSTS = [os.environ.get("ALLOWED_HOST")]
+CSRF_TRUSTED_ORIGINS = [os.environ.get("CSRF_TRUSTED_ORIGIN")]
+###########################
+# qstash-py settings
+###########################
+QSTASH_TOKEN = os.environ.get("QSTASH_TOKEN")
+QSTASH_CURRENT_SIGNING_KEY = os.environ.get("QSTASH_CURRENT_SIGNING_KEY")
+QSTASH_NEXT_SIGNING_KEY = os.environ.get("QSTASH_NEXT_SIGNING_KEY")
+
+###########################
+# django_qstash settings
+###########################
+DJANGO_QSTASH_DOMAIN = os.environ.get("DJANGO_QSTASH_DOMAIN")
+DJANGO_QSTASH_WEBHOOK_PATH = os.environ.get("DJANGO_QSTASH_WEBHOOK_PATH")
+DJANGO_QSTASH_FORCE_HTTPS = True
+DJANGO_QSTASH_RESULT_TTL = 604800
+```
 
 
 ## Schedule Tasks (Optional)
 
-The `django_qstash.schedules` app schedules tasks using Upstash [QStash Schedules](https://upstash.com/docs/qstash/features/schedules) and the django-qstash `@stashed_task` decorator.
+Run background tasks on a CRON schedule.
+
+The `django_qstash.schedules` app schedules tasks using Upstash [QStash Schedules](https://upstash.com/docs/qstash/features/schedules) via `@shared_task` or `@stashed_task` decorators along with the `TaskSchedule` model.
 
 ### Installation
 
@@ -303,8 +373,7 @@ Run migrations:
 python manage.py migrate django_qstash_schedules
 ```
 
-
-## Schedule a Task
+### Schedule a Task
 
 Tasks must exist before you can schedule them. Review [Define a Task](#define-a-task) for more information.
 
@@ -312,9 +381,6 @@ Here's how you can schedule a task:
 - Django Admin (`/admin/django_qstash_schedules/taskschedule/add/`)
 - Django shell (`python manage.py shell`)
 
-
-
-
 ```python
 from django_qstash.schedules.models import TaskSchedule
 from django_qstash.discovery.utils import discover_tasks
@@ -343,10 +409,11 @@ TaskSchedule.objects.create(
 - `cron` is the cron schedule to run the task. Use [contrab.guru](https://crontab.guru/) for writing the cron format.
 
 
-
 ## Store Task Results (Optional)
 
-In `django_qstash.results.models` we have the `TaskResult` model class that can be used to track async task results. These entries are created via webhooks.
+Retain the results of background tasks in the database with clear-out functionality.
+
+In `django_qstash.results.models` we have the `TaskResult` model class that can be used to track async task results. These entries are created via the django-qstash webhook view handler (`qstash_webhook_view`).
 
 To install it, just add `django_qstash.results` to your `INSTALLED_APPS` setting.
 
@@ -364,6 +431,12 @@ Run migrations:
 python manage.py migrate django_qstash_results
 ```
 
+Key configuration:
+
+- [DJANGO_QSTASH_WEBHOOK_PATH](#django-settings-configuration)
+- [DJANGO_QSTASH_DOMAIN](#django-settings-configuration)
+- [DJANGO_QSTASH_RESULT_TTL](#django-settings-configuration)
+
 ### Clear Stale Results
 
 We recommend purging the `TaskResult` model after a certain amount of time.

{django_qstash-0.0.11 → django_qstash-0.0.12}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "django-qstash"
-version = "0.0.11"
+version = "0.0.12"
 description = "A drop-in replacement for Celery's shared_task with Upstash QStash."
 readme = "README.md"
 license = { file = "LICENSE" }

{django_qstash-0.0.11 → django_qstash-0.0.12}/src/django_qstash/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__version__ = "0.0.11"
+__version__ = "0.0.12"
 
 from django_qstash.app import shared_task
 from django_qstash.app import stashed_task

{django_qstash-0.0.11 → django_qstash-0.0.12}/src/django_qstash/callbacks.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from django.core.exceptions import ImproperlyConfigured
+
 from django_qstash.settings import DJANGO_QSTASH_DOMAIN
 from django_qstash.settings import DJANGO_QSTASH_WEBHOOK_PATH
 
@@ -8,6 +10,10 @@ def get_callback_url() -> str:
     """
     Get the callback URL based on the settings.
     """
+    if DJANGO_QSTASH_DOMAIN is None:
+        raise ImproperlyConfigured("DJANGO_QSTASH_DOMAIN is not set")
+    if DJANGO_QSTASH_WEBHOOK_PATH is None:
+        raise ImproperlyConfigured("DJANGO_QSTASH_WEBHOOK_PATH is not set")
     callback_domain = DJANGO_QSTASH_DOMAIN.rstrip("/")
     if not callback_domain.startswith(("http://", "https://")):
         callback_domain = f"https://{callback_domain}"

django_qstash-0.0.12/src/django_qstash/cron.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+import re
+
+minute_re = re.compile(
+    r"^\*$|^[0-5]?\d$|^[0-5]?\d-[0-5]?\d$|^[0-5]?\d(,[0-5]?\d)+$|^\*/([1-9]|[1-5][0-9])$"
+)
+
+hour_re = re.compile(
+    r"^\*$|^([01]?\d|2[0-3])$|^([01]?\d|2[0-3])-([01]?\d|2[0-3])$|^([01]?\d|2[0-3])(,([01]?\d|2[0-3]))+$|^\*/([1-9]|1[0-9]|2[0-3])$"
+)
+
+day_of_month_re = re.compile(
+    r"^\*$|^([1-2]?\d|3[01])$|^([1-2]?\d|3[01])-([1-2]?\d|3[01])$|^([1-2]?\d|3[01])(,([1-2]?\d|3[01]))+$|^\*/([1-9]|[12]\d|3[01])$"
+)
+
+month_re = re.compile(
+    r"^\*$|^([1-9]|1[0-2])$|^([1-9]|1[0-2])-([1-9]|1[0-2])$|^([1-9]|1[0-2])(,([1-9]|1[0-2]))+$|^\*/([1-9]|1[0-2])$"
+)
+
+day_of_week_re = re.compile(r"^\*$|^[0-6]$|^[0-6]-[0-6]$|^[0-6](,[0-6])+$|^\*/[1-6]$")

django_qstash-0.0.12/src/django_qstash/db/models.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from django.db import models
+
+
+class TaskStatus(models.TextChoices):
+    PENDING = "PENDING", "Pending"
+    SUCCESS = "SUCCESS", "Success"
+    EXECUTION_ERROR = "EXECUTION_ERROR", "Execution Error"
+    INTERNAL_ERROR = "INTERNAL_ERROR", "Internal Error"
+    OTHER_ERROR = "OTHER_ERROR", "Other Error"
+    UNKNOWN = "UNKNOWN", "Unknown"

{django_qstash-0.0.11 → django_qstash-0.0.12}/src/django_qstash/handlers.py

@@ -9,6 +9,8 @@ from django.conf import settings
 from django.http import HttpRequest
 from qstash import Receiver
 
+from django_qstash.db.models import TaskStatus
+
 from . import utils
 from .exceptions import PayloadError
 from .exceptions import SignatureError
@@ -90,7 +92,9 @@ class QStashWebhook:
 
     def handle_request(self, request: HttpRequest) -> tuple[dict, int]:
         """Process webhook request and return response data and status code."""
-        payload = None  # Initialize payload as None
+        payload = None
+        task_id = request.headers.get("Upstash-Message-Id")
+
         try:
             body = request.body.decode()
             self.verify_signature(
@@ -101,14 +105,14 @@ class QStashWebhook:
 
             payload = self.parse_payload(body)
             result = self.execute_task(payload)
-
             store_task_result(
-                task_id=request.headers.get("Upstash-Message-Id"),
+                task_id=task_id,
                 task_name=payload.task_name,
-                status="SUCCESS",
+                status=TaskStatus.SUCCESS,
                 result=result,
                 args=payload.args,
                 kwargs=payload.kwargs,
+                function_path=payload.function_path,
             )
 
             return {
@@ -125,16 +129,37 @@ class QStashWebhook:
                 "error": str(e),
                 "task_name": getattr(payload, "task_name", None),
             }, 400
+
         except TaskError as e:
             logger.exception("Task execution error: %s", str(e))
+            store_task_result(
+                task_id=task_id,
+                task_name=payload.task_name,
+                status=TaskStatus.EXECUTION_ERROR,
+                traceback=str(e),
+                args=payload.args,
+                kwargs=payload.kwargs,
+                function_path=payload.function_path,
+            )
             return {
                 "status": "error",
                 "error_type": e.__class__.__name__,
                 "error": str(e),
-                "task_name": payload.task_name if payload else None,
-            }, 500
+                "task_name": payload.task_name,
+            }, 422
+
         except Exception as e:
             logger.exception("Unexpected error in webhook handler: %s", str(e))
+            if payload:  # Store unexpected errors only if payload was parsed
+                store_task_result(
+                    task_id=task_id,
+                    task_name=payload.task_name,
+                    status=TaskStatus.INTERNAL_ERROR,
+                    traceback=str(e),
+                    args=payload.args,
+                    kwargs=payload.kwargs,
+                    function_path=payload.function_path,
+                )
             return {
                 "status": "error",
                 "error_type": "InternalServerError",

{django_qstash-0.0.11 → django_qstash-0.0.12}/src/django_qstash/results/admin.py

@@ -17,5 +17,8 @@ class TaskResultAdmin(admin.ModelAdmin):
         "kwargs",
         "task_id",
         "date_created",
+        "function_path",
     ]
-    list_display = ["task_name", "status", "date_done"]
+    search_fields = ["task_name", "task_id", "function_path"]
+    list_display = ["task_name", "function_path", "status", "date_done"]
+    list_filter = ["status", "date_done"]