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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-qstash
-Version: 0.0.10
+Version: 0.0.11
 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
@@ -33,16 +33,32 @@ Requires-Dist: requests>=2.30
 
 _django-qstash_ is a drop-in replacement for Celery's `shared_task`.
 
-To do this, we use:
+
+## How it works
+
+In `tasks.py` in your apps:
+
+```python
+from django_qstash import shared_task
+
+
+@shared_task
+def my_task():
+    pass
+```
+> To use Celery too, you can use `@stashed_task` instead of `@shared_task` more below.
+
+To do this we need:
 
 - [Upstash QStash](https://upstash.com/docs/qstash/overall/getstarted)
-- A single public _webhook_ to call `@shared_task` functions automatically
+- A single public _webhook_ to call `@stashed_task` functions automatically
 
 This allows us to:
 
+- Nearly identical usage to Celery's `@shared_task` with far less configuration and overhead
 - Focus just on Django
-- Drop Celery
-- Truly scale Django to zero
+- Drop Celery completely, scale it down, or use it as normal. django-qstash can work hand-in-hand with Celery
+- Unlock true serverless and scale-to-zero for Django
 - Run background tasks through webhooks
 - Cut costs
 - Trigger GitHub Actions Workflows or GitLab CI/CD pipelines for handling other kinds of background tasks based on our project's code.
@@ -51,6 +67,7 @@ This allows us to:
 ## Table of Contents
 
 - [django-qstash](#django-qstash)
+  - [How it works](#how-it-works)
   - [Table of Contents](#table-of-contents)
   - [Installation](#installation)
     - [Using Pip](#using-pip)
@@ -98,9 +115,9 @@ INSTALLED_APPS = [
     ##...
 ]
 ```
-- `django_qstash` Includes the `@shared_task` decorator and webhook view
+- `django_qstash` Includes the `@shared_task` and `@stashed_task` decorators and webhook view
 - `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_ `@shared_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.
+- `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
 
@@ -144,7 +161,7 @@ There is a sample project in [sample_project/](sample_project/) that shows how a
 
 ## Usage
 
-Django-QStash revolves around the `shared_task` decorator. The goal is to be a drop-in replacement for Celery's `shared_task` decorator.
+Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `stashed_task` decorator.
 
 Here's how it works:
 - Define a Task
@@ -152,10 +169,10 @@ Here's how it works:
 
 ### Define a Task
 ```python
-from django_qstash import shared_task
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def hello_world(name: str, age: int = None, activity: str = None):
     if age is None:
         print(f"Hello {name}! I see you're {activity}.")
@@ -225,10 +242,13 @@ print(json.dumps(data))
 
 ```python
 # from celery import shared_task
-from django_qstash import shared_task
+# becomes
+# from django_qstash import shared_task
+# or
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def math_add_task(a, b, save_to_file=False, *args, **kwargs):
     logger.info(f"Adding {a} and {b}")
     if save_to_file:
@@ -292,7 +312,7 @@ In Django settings, you can configure the following:
 
 ## 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 `@shared_task` decorator.
+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.
 
 ### Installation
 

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

@@ -4,16 +4,32 @@
 
 _django-qstash_ is a drop-in replacement for Celery's `shared_task`.
 
-To do this, we use:
+
+## How it works
+
+In `tasks.py` in your apps:
+
+```python
+from django_qstash import shared_task
+
+
+@shared_task
+def my_task():
+    pass
+```
+> To use Celery too, you can use `@stashed_task` instead of `@shared_task` more below.
+
+To do this we need:
 
 - [Upstash QStash](https://upstash.com/docs/qstash/overall/getstarted)
-- A single public _webhook_ to call `@shared_task` functions automatically
+- A single public _webhook_ to call `@stashed_task` functions automatically
 
 This allows us to:
 
+- Nearly identical usage to Celery's `@shared_task` with far less configuration and overhead
 - Focus just on Django
-- Drop Celery
-- Truly scale Django to zero
+- Drop Celery completely, scale it down, or use it as normal. django-qstash can work hand-in-hand with Celery
+- Unlock true serverless and scale-to-zero for Django
 - Run background tasks through webhooks
 - Cut costs
 - Trigger GitHub Actions Workflows or GitLab CI/CD pipelines for handling other kinds of background tasks based on our project's code.
@@ -22,6 +38,7 @@ This allows us to:
 ## Table of Contents
 
 - [django-qstash](#django-qstash)
+  - [How it works](#how-it-works)
   - [Table of Contents](#table-of-contents)
   - [Installation](#installation)
     - [Using Pip](#using-pip)
@@ -69,9 +86,9 @@ INSTALLED_APPS = [
     ##...
 ]
 ```
-- `django_qstash` Includes the `@shared_task` decorator and webhook view
+- `django_qstash` Includes the `@shared_task` and `@stashed_task` decorators and webhook view
 - `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_ `@shared_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.
+- `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
 
@@ -115,7 +132,7 @@ There is a sample project in [sample_project/](sample_project/) that shows how a
 
 ## Usage
 
-Django-QStash revolves around the `shared_task` decorator. The goal is to be a drop-in replacement for Celery's `shared_task` decorator.
+Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `stashed_task` decorator.
 
 Here's how it works:
 - Define a Task
@@ -123,10 +140,10 @@ Here's how it works:
 
 ### Define a Task
 ```python
-from django_qstash import shared_task
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def hello_world(name: str, age: int = None, activity: str = None):
     if age is None:
         print(f"Hello {name}! I see you're {activity}.")
@@ -196,10 +213,13 @@ print(json.dumps(data))
 
 ```python
 # from celery import shared_task
-from django_qstash import shared_task
+# becomes
+# from django_qstash import shared_task
+# or
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def math_add_task(a, b, save_to_file=False, *args, **kwargs):
     logger.info(f"Adding {a} and {b}")
     if save_to_file:
@@ -263,7 +283,7 @@ In Django settings, you can configure the following:
 
 ## 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 `@shared_task` decorator.
+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.
 
 ### Installation
 

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

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

django_qstash-0.0.11/src/django_qstash/__init__.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+__version__ = "0.0.11"
+
+from django_qstash.app import shared_task
+from django_qstash.app import stashed_task
+
+__all__ = ["stashed_task", "shared_task"]

{django_qstash-0.0.10 → django_qstash-0.0.11}/src/django_qstash/app/__init__.py

@@ -3,5 +3,6 @@ from __future__ import annotations
 from .base import AsyncResult
 from .base import QStashTask
 from .decorators import shared_task
+from .decorators import stashed_task
 
-__all__ = ["AsyncResult", "QStashTask", "shared_task"]
+__all__ = ["AsyncResult", "QStashTask", "stashed_task", "shared_task"]

{django_qstash-0.0.10 → django_qstash-0.0.11}/src/django_qstash/app/decorators.py

@@ -6,24 +6,43 @@ from typing import Callable
 from django_qstash.app.base import QStashTask
 
 
-def shared_task(
+def stashed_task(
     func: Callable | None = None,
     name: str | None = None,
     deduplicated: bool = False,
     **options: dict[str, Any],
 ) -> QStashTask:
     """
-    Decorator that mimics Celery's shared_task
+    Decorator that mimics Celery's shared_task that maintains
+    Celery compatibility.
 
     Can be used as:
+
+        from django_qstash import shared_task
+
         @shared_task
         def my_task():
             pass
 
-        @shared_task(name="custom_name", deduplicated=True)
+        @stashed_task(name="custom_name", deduplicated=True)
         def my_task():
             pass
     """
     if func is not None:
         return QStashTask(func, name=name, deduplicated=deduplicated, **options)
     return lambda f: QStashTask(f, name=name, deduplicated=deduplicated, **options)
+
+
+def shared_task(func: Callable | None = None, **options: dict[str, Any]) -> QStashTask:
+    """
+    Decorator that is a drop-in replacement for Celery's shared_task.
+
+    Can be used as:
+
+        from django_qstash import shared_task
+
+        @shared_task
+        def my_task():
+            pass
+    """
+    return stashed_task(func, **options)

{django_qstash-0.0.10 → django_qstash-0.0.11}/src/django_qstash/results/tasks.py

@@ -7,14 +7,14 @@ from django.apps import apps
 from django.conf import settings
 from django.utils import timezone
 
-from django_qstash import shared_task
+from django_qstash import stashed_task
 
 DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
 
 logger = logging.getLogger(__name__)
 
 
-@shared_task(name="Cleanup Task Results")
+@stashed_task(name="Cleanup Task Results")
 def clear_stale_results_task(
     since=None, stdout=None, user_confirm=False, *args, **options
 ):

{django_qstash-0.0.10 → django_qstash-0.0.11}/src/django_qstash.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-qstash
-Version: 0.0.10
+Version: 0.0.11
 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
@@ -33,16 +33,32 @@ Requires-Dist: requests>=2.30
 
 _django-qstash_ is a drop-in replacement for Celery's `shared_task`.
 
-To do this, we use:
+
+## How it works
+
+In `tasks.py` in your apps:
+
+```python
+from django_qstash import shared_task
+
+
+@shared_task
+def my_task():
+    pass
+```
+> To use Celery too, you can use `@stashed_task` instead of `@shared_task` more below.
+
+To do this we need:
 
 - [Upstash QStash](https://upstash.com/docs/qstash/overall/getstarted)
-- A single public _webhook_ to call `@shared_task` functions automatically
+- A single public _webhook_ to call `@stashed_task` functions automatically
 
 This allows us to:
 
+- Nearly identical usage to Celery's `@shared_task` with far less configuration and overhead
 - Focus just on Django
-- Drop Celery
-- Truly scale Django to zero
+- Drop Celery completely, scale it down, or use it as normal. django-qstash can work hand-in-hand with Celery
+- Unlock true serverless and scale-to-zero for Django
 - Run background tasks through webhooks
 - Cut costs
 - Trigger GitHub Actions Workflows or GitLab CI/CD pipelines for handling other kinds of background tasks based on our project's code.
@@ -51,6 +67,7 @@ This allows us to:
 ## Table of Contents
 
 - [django-qstash](#django-qstash)
+  - [How it works](#how-it-works)
   - [Table of Contents](#table-of-contents)
   - [Installation](#installation)
     - [Using Pip](#using-pip)
@@ -98,9 +115,9 @@ INSTALLED_APPS = [
     ##...
 ]
 ```
-- `django_qstash` Includes the `@shared_task` decorator and webhook view
+- `django_qstash` Includes the `@shared_task` and `@stashed_task` decorators and webhook view
 - `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_ `@shared_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.
+- `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
 
@@ -144,7 +161,7 @@ There is a sample project in [sample_project/](sample_project/) that shows how a
 
 ## Usage
 
-Django-QStash revolves around the `shared_task` decorator. The goal is to be a drop-in replacement for Celery's `shared_task` decorator.
+Django-QStash revolves around the `stashed_task` decorator. The goal is to be a drop-in replacement for Celery's `stashed_task` decorator.
 
 Here's how it works:
 - Define a Task
@@ -152,10 +169,10 @@ Here's how it works:
 
 ### Define a Task
 ```python
-from django_qstash import shared_task
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def hello_world(name: str, age: int = None, activity: str = None):
     if age is None:
         print(f"Hello {name}! I see you're {activity}.")
@@ -225,10 +242,13 @@ print(json.dumps(data))
 
 ```python
 # from celery import shared_task
-from django_qstash import shared_task
+# becomes
+# from django_qstash import shared_task
+# or
+from django_qstash import stashed_task
 
 
-@shared_task
+@stashed_task
 def math_add_task(a, b, save_to_file=False, *args, **kwargs):
     logger.info(f"Adding {a} and {b}")
     if save_to_file:
@@ -292,7 +312,7 @@ In Django settings, you can configure the following:
 
 ## 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 `@shared_task` decorator.
+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.
 
 ### Installation
 

django_qstash-0.0.10/src/django_qstash/__init__.py

@@ -1,7 +0,0 @@
-from __future__ import annotations
-
-__version__ = "0.0.10"
-
-from django_qstash.app import shared_task
-
-__all__ = ["shared_task"]