django-qstash 0.0.12__py3-none-any.whl → 0.0.14__py3-none-any.whl

django_qstash/__init__.py

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

django_qstash/schedules/migrations/0003_alter_taskschedule_cron.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.1.4 on 2025-01-13 19:27
+
+from __future__ import annotations
+
+from django.db import migrations
+from django.db import models
+
+import django_qstash.schedules.validators
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("django_qstash_schedules", "0002_taskschedule_updated_at"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="taskschedule",
+            name="cron",
+            field=models.CharField(
+                default="*/5 * * * *",
+                help_text="Cron expression for scheduling the task",
+                max_length=255,
+                validators=[
+                    django_qstash.schedules.validators.validate_cron_expression
+                ],
+                verbose_name="Cron Expression",
+            ),
+        ),
+    ]

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.12.dist-info → django_qstash-0.0.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: django-qstash
-Version: 0.0.12
+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.12.dist-info → django_qstash-0.0.14.dist-info}/RECORD

@@ -1,10 +1,11 @@
-django_qstash/__init__.py,sha256=ENXrTf63lzkaRO580z6PPjYDS7bgC2bNaK24S-uqnbo,188
+django_qstash/__init__.py,sha256=X2HLkTrz3IPvofXBeKHkAqkJR823w9SRbbhs8kjVL9A,188
 django_qstash/callbacks.py,sha256=IQ-D8sPlSRuREZ1zwkRyd2GtxfmrJJh2x4jLd39rZCE,813
 django_qstash/client.py,sha256=cgHf-g6lDAltY_Vt6GUVJNY2JSz1czBOHL-WVkkLs2M,149
 django_qstash/cron.py,sha256=13OzTMGXFgjNEXjs2Et20WGZYtW9lKlu79BjbRySnVc,716
 django_qstash/exceptions.py,sha256=pH6kKRJFIVFkDHUJQ9yRWmtGdBBSXpNAwMSFuNzMgPw,392
 django_qstash/handlers.py,sha256=TtYZ-Sr858ajISBpDuHIT7-qaVsoVfTE6vVFJ9-kpPE,5820
 django_qstash/settings.py,sha256=YvpXMo1AdIWvbotISWJmhg0vrW3A3UQ4BieNzMfRC7Y,524
+django_qstash/urls.py,sha256=1dNblYOCIBdqSXbA1jSL9H0aiXN5gIDVwhfZeC4-DQw,172
 django_qstash/utils.py,sha256=wrTU30cobO2di18BNEFtKD4ih2euf7eQNpg6p6TkQ1Y,1185
 django_qstash/views.py,sha256=H32f_jGnlwOTO0YG9znNo2b-GRYZ8TM-Wt0T62SGdXM,639
 django_qstash/app/__init__.py,sha256=kmoCVoESInzCZ_oGUiPVY4GsFQwBC07cqFJCyn9Loyk,240
@@ -43,8 +44,9 @@ django_qstash/schedules/signals.py,sha256=g1aRAbZx-stnvD589mZagR6I27E56064fUyWsx
 django_qstash/schedules/validators.py,sha256=w1dLgf_rAujurcktGPgu1aXejT5BhH5ianKSr7cEYKU,2467
 django_qstash/schedules/migrations/0001_initial.py,sha256=66cA8xnJV3h7QgzCaOiv-Nu3Xl9IdZQPgQKhxyW3bs4,4516
 django_qstash/schedules/migrations/0002_taskschedule_updated_at.py,sha256=6hZO0a9P2ZpOROkk7O5UXBhahghU0QfxZl4E-c3HKGw,459
+django_qstash/schedules/migrations/0003_alter_taskschedule_cron.py,sha256=oBW_FcvosKsa0l_l3eVDRIZli5K1wQaN_DJjamVe23s,826
 django_qstash/schedules/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_qstash-0.0.12.dist-info/METADATA,sha256=NIxqfsPXtnoculriqbmMK9d_4PkFwvX-D2ey4U43hY0,19422
-django_qstash-0.0.12.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-django_qstash-0.0.12.dist-info/top_level.txt,sha256=AlV3WSK1A0ZvKuCLsINtIJhJW8zo7SEB-D3_RAjZ0hI,14
-django_qstash-0.0.12.dist-info/RECORD,,
+django_qstash-0.0.14.dist-info/METADATA,sha256=IwrF28uwoTMPK18baWNm_-T_8bHMB9GyHV-QFMgC-fE,19748
+django_qstash-0.0.14.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+django_qstash-0.0.14.dist-info/top_level.txt,sha256=AlV3WSK1A0ZvKuCLsINtIJhJW8zo7SEB-D3_RAjZ0hI,14
+django_qstash-0.0.14.dist-info/RECORD,,

{django_qstash-0.0.12.dist-info → django_qstash-0.0.14.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.7.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any