django-qstash 0.0.13__tar.gz → 0.0.14__tar.gz

{django_qstash-0.0.13 → django_qstash-0.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-qstash
-Version: 0.0.13
+Version: 0.0.14
 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
@@ -72,7 +72,7 @@ This allows us to:
   - [Installation](#installation)
     - [Using Pip](#using-pip)
     - [Update Settings (`settings.py`)](#update-settings-settingspy)
-    - [Configure Webhook URL](#configure-webhook-url)
+    - [Configure QStash Webhook Handler](#configure-qstash-webhook-handler)
     - [Required Environment Variables](#required-environment-variables)
   - [Sample Project](#sample-project)
   - [Dependencies](#dependencies)
@@ -123,20 +123,27 @@ INSTALLED_APPS = [
 - `django_qstash.results` (Optional): Store task results in Django DB
 - `django_qstash.schedules` (Optional): Use QStash Schedules to run your `django_qstash` tasks. Out of the box support for _django_qstash_ `@stashed_task`. Schedule tasks using _cron_ (e.g. `0 0 * * *`) format which is required based on [QStash Schedules](https://upstash.com/docs/qstash/features/schedules). use [contrab.guru](https://crontab.guru/) for writing the cron format.
 
-### Configure Webhook URL
+### Configure QStash Webhook Handler
+
+Set it and forget it. `django_qstash` will handle the webhook from qstash automatically for you.
 
 In your `ROOT_URLCONF` (e.g. `urls.py`), add the following:
+
 ```python
-from django_qstash.views import qstash_webhook_view
+from django.urls import include
 
 urlpatterns = [
     # ...
-    path("qstash/webhook/", qstash_webhook_view),
+    path("qstash/webhook/", include("django_qstash.urls")),
     # ...
 ]
 ```
 Be sure to use this path in your `DJANGO_QSTASH_WEBHOOK_PATH` environment variable.
 
+
+The `django_qstash` webhook handler runs your `@shared_task` or `@stashed_task` functions via the `importlib` module. In other words, you should not need to modify the webhook handler.
+
+
 ### Required Environment Variables
 
 Get your QStash token and signing keys from [Upstash](https://upstash.com/).
@@ -348,7 +355,7 @@ Various options are available to configure django-qstash.
 
 ### 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).
+For a complete example, review [sample_project/cfehome/settings.py](sample_project/cfehome/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

{django_qstash-0.0.13 → django_qstash-0.0.14}/README.md

@@ -43,7 +43,7 @@ This allows us to:
   - [Installation](#installation)
     - [Using Pip](#using-pip)
     - [Update Settings (`settings.py`)](#update-settings-settingspy)
-    - [Configure Webhook URL](#configure-webhook-url)
+    - [Configure QStash Webhook Handler](#configure-qstash-webhook-handler)
     - [Required Environment Variables](#required-environment-variables)
   - [Sample Project](#sample-project)
   - [Dependencies](#dependencies)
@@ -94,20 +94,27 @@ INSTALLED_APPS = [
 - `django_qstash.results` (Optional): Store task results in Django DB
 - `django_qstash.schedules` (Optional): Use QStash Schedules to run your `django_qstash` tasks. Out of the box support for _django_qstash_ `@stashed_task`. Schedule tasks using _cron_ (e.g. `0 0 * * *`) format which is required based on [QStash Schedules](https://upstash.com/docs/qstash/features/schedules). use [contrab.guru](https://crontab.guru/) for writing the cron format.
 
-### Configure Webhook URL
+### Configure QStash Webhook Handler
+
+Set it and forget it. `django_qstash` will handle the webhook from qstash automatically for you.
 
 In your `ROOT_URLCONF` (e.g. `urls.py`), add the following:
+
 ```python
-from django_qstash.views import qstash_webhook_view
+from django.urls import include
 
 urlpatterns = [
     # ...
-    path("qstash/webhook/", qstash_webhook_view),
+    path("qstash/webhook/", include("django_qstash.urls")),
     # ...
 ]
 ```
 Be sure to use this path in your `DJANGO_QSTASH_WEBHOOK_PATH` environment variable.
 
+
+The `django_qstash` webhook handler runs your `@shared_task` or `@stashed_task` functions via the `importlib` module. In other words, you should not need to modify the webhook handler.
+
+
 ### Required Environment Variables
 
 Get your QStash token and signing keys from [Upstash](https://upstash.com/).
@@ -319,7 +326,7 @@ Various options are available to configure django-qstash.
 
 ### 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).
+For a complete example, review [sample_project/cfehome/settings.py](sample_project/cfehome/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

{django_qstash-0.0.13 → django_qstash-0.0.14}/pyproject.toml

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

{django_qstash-0.0.13 → django_qstash-0.0.14}/src/django_qstash/__init__.py

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

django_qstash-0.0.14/src/django_qstash/urls.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from django.urls import path
+
+from django_qstash.views import qstash_webhook_view
+
+urlpatterns = [
+    path("", qstash_webhook_view),
+]

{django_qstash-0.0.13 → django_qstash-0.0.14}/src/django_qstash.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-qstash
-Version: 0.0.13
+Version: 0.0.14
 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
@@ -72,7 +72,7 @@ This allows us to:
   - [Installation](#installation)
     - [Using Pip](#using-pip)
     - [Update Settings (`settings.py`)](#update-settings-settingspy)
-    - [Configure Webhook URL](#configure-webhook-url)
+    - [Configure QStash Webhook Handler](#configure-qstash-webhook-handler)
     - [Required Environment Variables](#required-environment-variables)
   - [Sample Project](#sample-project)
   - [Dependencies](#dependencies)
@@ -123,20 +123,27 @@ INSTALLED_APPS = [
 - `django_qstash.results` (Optional): Store task results in Django DB
 - `django_qstash.schedules` (Optional): Use QStash Schedules to run your `django_qstash` tasks. Out of the box support for _django_qstash_ `@stashed_task`. Schedule tasks using _cron_ (e.g. `0 0 * * *`) format which is required based on [QStash Schedules](https://upstash.com/docs/qstash/features/schedules). use [contrab.guru](https://crontab.guru/) for writing the cron format.
 
-### Configure Webhook URL
+### Configure QStash Webhook Handler
+
+Set it and forget it. `django_qstash` will handle the webhook from qstash automatically for you.
 
 In your `ROOT_URLCONF` (e.g. `urls.py`), add the following:
+
 ```python
-from django_qstash.views import qstash_webhook_view
+from django.urls import include
 
 urlpatterns = [
     # ...
-    path("qstash/webhook/", qstash_webhook_view),
+    path("qstash/webhook/", include("django_qstash.urls")),
     # ...
 ]
 ```
 Be sure to use this path in your `DJANGO_QSTASH_WEBHOOK_PATH` environment variable.
 
+
+The `django_qstash` webhook handler runs your `@shared_task` or `@stashed_task` functions via the `importlib` module. In other words, you should not need to modify the webhook handler.
+
+
 ### Required Environment Variables
 
 Get your QStash token and signing keys from [Upstash](https://upstash.com/).
@@ -348,7 +355,7 @@ Various options are available to configure django-qstash.
 
 ### 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).
+For a complete example, review [sample_project/cfehome/settings.py](sample_project/cfehome/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

{django_qstash-0.0.13 → django_qstash-0.0.14}/src/django_qstash.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ src/django_qstash/cron.py
 src/django_qstash/exceptions.py
 src/django_qstash/handlers.py
 src/django_qstash/settings.py
+src/django_qstash/urls.py
 src/django_qstash/utils.py
 src/django_qstash/views.py
 src/django_qstash.egg-info/PKG-INFO