django-queuebie 0.6.0__tar.gz → 0.7.1__tar.gz

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/.github/workflows/quality-gate.yml

@@ -7,10 +7,10 @@ jobs:
   linting:
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - name: Set up Python 3.14
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: "3.14"
 
@@ -36,13 +36,13 @@ jobs:
             django-version: 61
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: setup python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.0.0
+        uses: astral-sh/setup-uv@v10.3.0
         with:
           cache-suffix: ${{ github.ref_type }}
       - name: Install tox
@@ -64,9 +64,9 @@ jobs:
     runs-on: ubuntu-24.04
     needs: tests
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
-      - uses: actions/setup-python@v6
+      - uses: actions/setup-python@v7
         with:
           python-version: '3.14'
 

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
     outputs:
       on-main: ${{ steps.check.outputs.on-main }}
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Check if tag is on main
@@ -41,15 +41,15 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - name: Set up Python 3.14
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: "3.14"
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.0.0
+        uses: astral-sh/setup-uv@v10.3.0
 
       - name: Build packages
         run: uv build
@@ -76,7 +76,7 @@ jobs:
           path: dist/
 
       - name: Sign packages with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v3.3.0
+        uses: sigstore/gh-action-sigstore-python@v3.5.0
         with:
           inputs: >-
             ./dist/*.tar.gz

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/.gitignore

@@ -81,6 +81,11 @@ target/
 profile_default/
 ipython_config.py
 
+# uv
+#   This is a library, so consumers never install from the lockfile. Not committing it avoids
+#   lockfile churn in every maintenance release.
+uv.lock
+
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
 #pdm.lock

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.16.4
+    rev: v0.17.1
     hooks:
       # Run the Ruff formatter.
       - id: ruff-format
@@ -15,24 +15,25 @@ repos:
     rev: 1.20.0
     hooks:
       - id: blacken-docs
+        args: [--line-length, "120"]
         additional_dependencies:
-        - black==26.5.1
+        - black==26.10.1
         files: '(?:README\.md|\.ambient-package-update\/templates\/snippets\/.*\.tpl|docs\/.*\.(?:md|rst))'
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.21.2
+    rev: v3.22.0
     hooks:
       - id: pyupgrade
         args: [ --py311-plus ]
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.32.0
+    rev: 1.33.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "5.2"]
 
   - repo: https://github.com/adamchainz/djade-pre-commit
-    rev: 1.9.0
+    rev: 1.10.0
     hooks:
     -   id: djade
         args: [--target-version, "5.2"]

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/CHANGES.md

@@ -1,5 +1,17 @@
 # Changelog
 
+**0.7.1** (2026-10-21)
+  * Updated the linting and CI setup to the current ambient-package-update template (ruff 0.17.1, `actions/checkout` v7, `actions/setup-python` v7)
+  * Fixed the Sphinx configuration for sphinx-rtd-theme 3, removing the documentation build warnings
+  * Fixed broken links in the pre-commit section of `CONTRIBUTING.md`
+  * Stopped committing `uv.lock`, since the package is a library and the lockfile never reaches its users
+
+**0.7.0** (2026-10-05)
+  * `handle_message()` returns the handled messages in the order they were processed - the initial message(s)
+    followed by every command and event raised along the way - so the caller can tell whether its command led to the
+    expected event
+  * `handle_message()` no longer empties a list passed in by the caller
+
 **0.6.0** (2026-09-09)
   * Auto-discovery now walks the whole subtree of every local Django app, so `handlers/commands` and `handlers/events`
     directories may live in sub-packages instead of only at the app root

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 - Create a Python virtualenv and activate it
 - Install "uv" with `pip install -U uv`
-- Sync the requirements with `uv sync --frozen --extra dev`
+- Sync the requirements with `uv sync --extra dev`
 
 ## Add functionality
 
@@ -36,9 +36,8 @@ To enable the configured pre-push hooks, you need to [install](https://pre-commi
 
     pre-commit install -t pre-push -t pre-commit --install-hooks
 
-This will permanently install the git hooks for both, frontend and backend, in your local
-[`.git/hooks`](./.git/hooks) folder.
-The hooks are configured in the [`.pre-commit-config.yaml`](templates/.pre-commit-config.yaml.tpl).
+This will permanently install the git hooks in your local `.git/hooks` folder.
+The hooks are configured in the [`.pre-commit-config.yaml`](./.pre-commit-config.yaml).
 
 You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
 

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: django-queuebie
-Version: 0.6.0
+Version: 0.7.1
 Summary: A simple and synchronous message queue for commands and events for Django
 Project-URL: Homepage, https://github.com/ambient-innovation/django-queuebie/
 Project-URL: Documentation, https://django-queuebie.readthedocs.io/en/latest/index.html
@@ -52,15 +52,15 @@ Requires-Dist: django>=5.2
 Provides-Extra: dev
 Requires-Dist: ambient-package-update; extra == 'dev'
 Requires-Dist: keyring~=25.7; extra == 'dev'
-Requires-Dist: pre-commit~=4.3; extra == 'dev'
-Requires-Dist: pytest-cov~=7.0; extra == 'dev'
-Requires-Dist: pytest-django~=4.11; extra == 'dev'
-Requires-Dist: pytest-mock~=3.15; extra == 'dev'
+Requires-Dist: pre-commit~=4.7; extra == 'dev'
+Requires-Dist: pytest-cov~=7.1; extra == 'dev'
+Requires-Dist: pytest-django~=4.14; extra == 'dev'
+Requires-Dist: pytest-mock~=3.17; extra == 'dev'
 Requires-Dist: sphinx-mdinclude~=0.6; extra == 'dev'
-Requires-Dist: sphinx-rtd-theme~=3.0; extra == 'dev'
-Requires-Dist: sphinx~=7.4; extra == 'dev'
-Requires-Dist: typer~=0.19; extra == 'dev'
-Requires-Dist: uv~=0.9; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme~=3.1; extra == 'dev'
+Requires-Dist: sphinx~=8.2; extra == 'dev'
+Requires-Dist: typer~=0.27; extra == 'dev'
+Requires-Dist: uv~=0.13; extra == 'dev'
 Description-Content-Type: text/markdown
 
 [![PyPI release](https://img.shields.io/pypi/v/django-queuebie.svg)](https://pypi.org/project/django-queuebie/)

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/docs/conf.py

@@ -68,14 +68,9 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 # a list of builtin themes.
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    "display_version": False,
+    "version_selector": False,
     "style_external_links": False,
 }
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
 # Set master doc file
 master_doc = "index"

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/docs/features/getting-started.md

@@ -102,3 +102,19 @@ handle_message(
     )
 )
 ```
+
+`handle_message()` returns every message it handled, in the order they were processed: the message(s) you passed in,
+followed by all commands and events the handlers returned along the way. Use it to find out what your command led to,
+for example when a command handler can decide to do nothing and return `None`:
+
+```python
+handled = handle_message(BuyProduct(...))
+
+if any(isinstance(message, ProductBought) for message in handled):
+    messages.success(request, "Thank you for your purchase.")
+else:
+    messages.error(request, "The product could not be bought.")
+```
+
+The returned list tells you which handlers ran, not that their changes are committed. If you call `handle_message()`
+inside an outer `transaction.atomic()` block, that outer transaction can still roll everything back.

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/pyproject.toml

@@ -37,15 +37,15 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-   'typer~=0.19',
-   'pytest-cov~=7.0',
-   'pytest-django~=4.11',
-   'pytest-mock~=3.15',
-   'pre-commit~=4.3',
-   'sphinx~=7.4',
-   'sphinx-rtd-theme~=3.0',
+   'typer~=0.27',
+   'pytest-cov~=7.1',
+   'pytest-django~=4.14',
+   'pytest-mock~=3.17',
+   'pre-commit~=4.7',
+   'sphinx~=8.2',
+   'sphinx-rtd-theme~=3.1',
    'sphinx-mdinclude~=0.6',
-   'uv~=0.9',
+   'uv~=0.13',
    'keyring~=25.7',
    'ambient-package-update',
 ]
@@ -202,9 +202,11 @@ env_list = ["django52", "django60", "django61", ]
 # Django deprecation overview: https://www.djangoproject.com/download/
 package = "wheel"
 wheel_build_env = ".pkg"
-# This runner syncs from the lockfile and ignores "deps", so every environment below
+# This runner installs via "uv sync" and ignores "deps", so every environment below
 # installs its matrix Django version on top of the synced environment.
 runner = "uv-venv-lock-runner"
+# uv.lock is not committed for libraries, so tox resolves fresh instead of asserting a lockfile.
+uv_sync_locked = false
 extras = ["dev", ]
 commands = [
     ["pytest", "--cov=queuebie", "--cov-report=term", "--cov-report=xml", "--ds", "settings", "tests"]

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/queuebie/__init__.py

@@ -1,6 +1,6 @@
 """A simple and synchronous message queue for commands and events for Django"""
 
-__version__ = "0.6.0"
+__version__ = "0.7.1"
 
 from queuebie.registry import MessageRegistry
 

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/queuebie/runner.py

@@ -11,8 +11,16 @@ from queuebie.messages import Command, Event, Message
 from queuebie.settings import get_queuebie_strict_mode
 
 
-def handle_message(messages: Message | list[Message]) -> None:
-    queue: list[Message] = messages if isinstance(messages, list) else [messages]
+def handle_message(messages: Message | list[Message]) -> list[Message]:
+    """
+    Process the given message(s) and every message their handlers return, until the queue is drained.
+
+    Returns all handled messages in the order they were processed - the initial message(s) first, followed by
+    everything raised along the way. The caller can inspect it to learn what its command led to, e.g. whether a
+    handler returned an event or bailed out with `None`.
+    """
+    # Copy the input, so draining the queue doesn't empty the caller's list
+    queue: list[Message] = list(messages) if isinstance(messages, list) else [messages]
 
     for message in queue:
         if not isinstance(message, (Command, Event)):
@@ -21,9 +29,11 @@ def handle_message(messages: Message | list[Message]) -> None:
     # Run auto-registry
     message_registry.autodiscover()
 
+    handled: list[Message] = []
     with transaction.atomic():
         while queue:
             message = queue.pop(0)
+            handled.append(message)
             if isinstance(message, Command):
                 handler_list = message_registry.command_dict.get(message.module_path(), [])
                 block_db_access = False
@@ -34,6 +44,8 @@ def handle_message(messages: Message | list[Message]) -> None:
             new_messages = _process_message(handler_list=handler_list, message=message, block_db_access=block_db_access)
             queue.extend(new_messages)
 
+    return handled
+
 
 def _process_message(*, handler_list: list, message: [Command, Event], block_db_access: bool) -> list[Message]:
     """

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/scripts/unix/install_requirements.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 pip install -U uv
-uv sync --frozen --extra dev
+uv sync --extra dev

django_queuebie-0.7.1/scripts/windows/install_requirements.ps1

@@ -0,0 +1,2 @@
+pip install -U uv
+uv sync --extra dev

{django_queuebie-0.6.0 → django_queuebie-0.7.1}/tests/test_runner.py

@@ -136,3 +136,47 @@ def test_handle_message_atomic_works(*args):
         handle_message([CreateUser(username="username"), RaiseRuntimeError(error_msg="Something is broken.")])
 
     assert User.objects.filter(username="username").exists() is False
+
+
+@pytest.mark.django_db
+def test_handle_message_returns_handled_messages_in_order():
+    command = DoSomething(my_var=1)
+
+    handled = handle_message(messages=command)
+
+    assert len(handled) == 2  # noqa: PLR2004
+    assert handled[0] is command
+    assert isinstance(handled[1], SomethingHappened)
+    assert handled[1].other_var == 2  # noqa: PLR2004
+
+
+@pytest.mark.django_db
+def test_handle_message_returns_only_initial_message_if_handler_returns_none():
+    command = CriticalCommand(my_var=1)
+
+    handled = handle_message(messages=command)
+
+    assert handled == [command]
+
+
+@pytest.mark.django_db
+def test_handle_message_returns_all_initial_messages_of_list():
+    command = DoSomething(my_var=1)
+    event = SomethingHappened(other_var=5)
+
+    handled = handle_message(messages=[command, event])
+
+    assert handled[0] is command
+    assert handled[1] is event
+    assert isinstance(handled[2], SomethingHappened)
+    assert handled[2].other_var == 2  # noqa: PLR2004
+    assert len(handled) == 3  # noqa: PLR2004
+
+
+@pytest.mark.django_db
+def test_handle_message_does_not_empty_passed_list():
+    message_list = [CriticalCommand(my_var=1)]
+
+    handle_message(messages=message_list)
+
+    assert len(message_list) == 1

django_queuebie-0.6.0/scripts/windows/install_requirements.ps1

@@ -1,2 +0,0 @@
-pip install -U uv
-uv sync --frozen --extra dev