django-queuebie 0.3.3__tar.gz → 0.3.6__tar.gz

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/.ambient-package-update/metadata.py

@@ -27,6 +27,7 @@ METADATA = PackageMetadata(
     development_status=DEPLOYMENT_STATUS_BETA,
     has_migrations=False,
     main_branch="main",
+    claim="A simple and synchronous message queue for commands and events for Django",
     readme_content=ReadmeContent(uses_internationalisation=True),
     dependencies=[
         f"Django>={SUPPORTED_DJANGO_VERSIONS[0]}",

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/.github/workflows/ci.yml

@@ -12,17 +12,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.12
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Install required packages
         run: pip install pre-commit
 
       - name: Run pre-commit hooks
-        run: pre-commit run --all-files --hook-stage push
-
+        run: pre-commit run --all-files
 
   tests:
     name: Python ${{ matrix.python-version }}, django ${{ matrix.django-version }}
@@ -46,8 +45,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
       - name: Install tox
-        run: pip install tox
+        run: uv pip install --system tox tox-uv
       - name: Run Tests
         env:
           TOXENV: django${{ matrix.django-version }}
@@ -56,7 +57,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: coverage-data-${{ matrix.python-version }}-${{ matrix.django-version }}
-          path: '${{ github.workspace }}/.coverage.*'
+          path: '${{ github.workspace }}/.coverage'
           include-hidden-files: true
           if-no-files-found: error
 
@@ -69,7 +70,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version: '3.13'
 
       - name: Install dependencies
         run: python -m pip install --upgrade coverage[toml]
@@ -77,13 +78,14 @@ jobs:
       - name: Download data
         uses: actions/download-artifact@v4
         with:
-          path: ${{ github.workspace }}
+          path: ${{ github.workspace }}/coverage-reports
           pattern: coverage-data-*
-          merge-multiple: true
+          merge-multiple: false
 
       - name: Combine coverage and fail if it's <100.0%
         run: |
-          python -m coverage combine
+          python -m coverage combine coverage-reports/*/.coverage
+          python -m coverage xml
           python -m coverage html --skip-covered --skip-empty
           python -m coverage report --fail-under=100.0
           echo "## Coverage summary" >> $GITHUB_STEP_SUMMARY

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/.gitignore

@@ -140,7 +140,7 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-# Requirements.txt is managed by pip-tools
+# Deprecated dependency files
 requirements.txt
 
 # sphinx build folder
@@ -156,3 +156,6 @@ _build
 
 # Test databases
 *.sqlite
+
+# AI
+.claude/

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/.pre-commit-config.yaml

@@ -3,36 +3,36 @@
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.14.0
     hooks:
       # Run the Ruff formatter.
       - id: ruff-format
       # Run the Ruff linter.
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.19.1
+    rev: 1.20.0
     hooks:
       - id: blacken-docs
         additional_dependencies:
-        - black==25.1.0
+        - black==25.9.0
         files: '(?:README\.md|\.ambient-package-update\/templates\/snippets\/.*\.tpl|docs\/.*\.(?:md|rst))'
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
         args: [ --py310-plus ]
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.24.0
+    rev: 1.29.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "4.2"]
 
   - repo: https://github.com/adamchainz/djade-pre-commit
-    rev: 1.3.2
+    rev: 1.6.0
     hooks:
     -   id: djade
         args: [--target-version, "4.2"]
@@ -43,12 +43,17 @@ repos:
           )$
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
-      - id: no-commit-to-branch
-        args:
-          [
-            "--pattern",
-            '^^(?!(?:feature|hotfix|bugfix|refactor|maintenance)/[\w\d\-_#]+).*$',
-          ]
-        stages: [ pre-commit ]
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.12"
+    python: "3.13"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/CHANGES.md

@@ -1,5 +1,14 @@
 # Changelog
 
+**0.3.6** (2025-10-10)
+  * Maintenance updates via ambient-package-update
+
+**0.3.5** (2025-10-09)
+  * Maintenance updates via ambient-package-update
+
+**0.3.4** (2025-05-29)
+  * Maintenance updates via ambient-package-update
+
 **0.3.3** (2025-04-03)
   * Clarified package tagline
 

django_queuebie-0.3.6/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contribute
+
+## Setup package for development
+
+- Create a Python virtualenv and activate it
+- Install "uv" with `pip install -U uv`
+- Sync the requirements with `uv sync --frozen --group dev`
+
+## Add functionality
+
+- Create a new branch for your feature
+- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
+  `-e /Users/workspace/django-queuebie` or via pip  `pip install -e /Users/workspace/django-queuebie`
+- Ensure the code passes the tests
+- Create a pull request
+
+## Run tests
+
+- Run tests
+  ````
+  pytest --ds settings tests
+  ````
+
+- Check coverage
+  ````
+  coverage run -m pytest --ds settings tests
+  coverage report -m
+  ````
+
+## Git hooks (via pre-commit)
+
+We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in
+vain.
+
+To enable the configured pre-push hooks, you need to [install](https://pre-commit.com/) pre-commit and run once:
+
+    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).
+
+You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
+
+    pre-commit run [hook-id] [options]
+
+Example: run single hook
+
+    pre-commit run ruff --all-files
+
+Example: run all hooks of pre-push stage
+
+    pre-commit run --all-files
+
+## Update documentation
+
+- To build the documentation, run: `sphinx-build docs/ docs/_build/html/`.
+- Open `docs/_build/html/index.html` to see the documentation.
+
+### Translation files
+
+If you have added custom text, make sure to wrap it in `_()` where `_` is
+gettext_lazy (`from django.utils.translation import gettext_lazy as _`).
+
+How to create translation file:
+
+* Navigate to `queuebie`
+* `python manage.py makemessages -l de`
+* Have a look at the new/changed files within `queuebie/locale`
+
+How to compile translation files:
+
+* Navigate to `queuebie`
+* `python manage.py compilemessages`
+* Have a look at the new/changed files within `queuebie/locale`

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/PKG-INFO

@@ -1,9 +1,36 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: django-queuebie
-Version: 0.3.3
+Version: 0.3.6
 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
+Project-URL: Maintained by, https://ambient.digital/
+Project-URL: Bugtracker, https://github.com/ambient-innovation/django-queuebie/issues
+Project-URL: Changelog, https://django-queuebie.readthedocs.io/en/latest/features/changelog.html
 Author-email: Ambient Digital <hello@ambient.digital>
-Description-Content-Type: text/markdown
+License: MIT License
+        
+        Copyright (c) 2025 Ambient Innovation: GmbH
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+License-File: LICENSE.md
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
@@ -21,26 +48,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Utilities
-Requires-Dist: Django>=4.2
-Requires-Dist: typer~=0.12 ; extra == "dev"
-Requires-Dist: pytest-django~=4.9 ; extra == "dev"
-Requires-Dist: pytest-mock~=3.14 ; extra == "dev"
-Requires-Dist: coverage~=7.6 ; extra == "dev"
-Requires-Dist: pre-commit~=4.0 ; extra == "dev"
-Requires-Dist: ruff~=0.6 ; extra == "dev"
-Requires-Dist: sphinx~=7.1 ; extra == "dev"
-Requires-Dist: sphinx-rtd-theme~=2.0 ; extra == "dev"
-Requires-Dist: m2r2==0.3.3.post2 ; extra == "dev"
-Requires-Dist: mistune<2.0.0 ; extra == "dev"
-Requires-Dist: flit~=3.9 ; extra == "dev"
-Requires-Dist: keyring~=25.4 ; extra == "dev"
-Requires-Dist: ambient-package-update ; extra == "dev"
-Project-URL: Bugtracker, https://github.com/ambient-innovation/django-queuebie/issues
-Project-URL: Changelog, https://django-queuebie.readthedocs.io/en/latest/features/changelog.html
-Project-URL: Documentation, https://django-queuebie.readthedocs.io/en/latest/index.html
-Project-URL: Homepage, https://github.com/ambient-innovation/django-queuebie/
-Project-URL: Maintained by, https://ambient.digital/
-Provides-Extra: dev
+Requires-Python: >=3.10
+Requires-Dist: django>=4.2
+Description-Content-Type: text/markdown
 
 [![PyPI release](https://img.shields.io/pypi/v/django-queuebie.svg)](https://pypi.org/project/django-queuebie/)
 [![Downloads](https://static.pepy.tech/badge/django-queuebie)](https://pepy.tech/project/django-queuebie)
@@ -51,11 +61,9 @@ Provides-Extra: dev
 
 A simple and synchronous message queue for commands and events for Django.
 
-* [PyPI](https://pypi.org/project/django-queuebie/)
-* [GitHub](https://github.com/ambient-innovation/django-queuebie)
-* [Full documentation](https://django-queuebie.readthedocs.io/en/latest/index.html)
-* Creator & Maintainer: [Ambient Digital](https://ambient.digital/)
+[PyPI](https://pypi.org/project/django-queuebie/) | [GitHub](https://github.com/ambient-innovation/django-queuebie) | [Full documentation](https://django-queuebie.readthedocs.io/en/latest/index.html)
 
+Creator & Maintainer: [Ambient Digital](https://ambient.digital/)
 
 ## Features
 
@@ -117,99 +125,18 @@ handle_message(
 
   `pip install django_queuebie`
 
-  or via pipenv:
+  or via uv:
 
-  `pipenv install django_queuebie`
+  `uv add django_queuebie`
 
 - Add module to `INSTALLED_APPS` within the main django `settings.py`:
 
-    ```python
-    INSTALLED_APPS = (
-        # ...
-        "queuebie",
-    )
-    ```
-
-
-
-## Contribute
-
-### Setup package for development
-
-- Create a Python virtualenv and activate it
-- Install "pip-tools" with `pip install -U pip-tools`
-- Compile the requirements with `pip-compile --extra dev, -o requirements.txt pyproject.toml --resolver=backtracking`
-- Sync the dependencies with your virtualenv with `pip-sync`
-
-### Add functionality
-
-- Create a new branch for your feature
-- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
-  `-e /Users/workspace/django-queuebie` or via pip  `pip install -e /Users/workspace/django-queuebie`
-- Ensure the code passes the tests
-- Create a pull request
-
-### Run tests
-
-- Run tests
-  ````
-  pytest --ds settings tests
-  ````
-
-- Check coverage
-  ````
-  coverage run -m pytest --ds settings tests
-  coverage report -m
-  ````
-
-### Git hooks (via pre-commit)
-
-We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in
-vain.
-
-To enable the configured pre-push hooks, you need to [install](https://pre-commit.com/) pre-commit and run once:
-
-    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).
-
-You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
-
-    pre-commit run [hook-id] [options]
-
-Example: run single hook
-
-    pre-commit run ruff --all-files
-
-Example: run all hooks of pre-push stage
-
-    pre-commit run --all-files --hook-stage push
-
-### Update documentation
-
-- To build the documentation, run: `sphinx-build docs/ docs/_build/html/`.
-- Open `docs/_build/html/index.html` to see the documentation.
-
-
-### Translation files
-
-If you have added custom text, make sure to wrap it in `_()` where `_` is
-gettext_lazy (`from django.utils.translation import gettext_lazy as _`).
-
-How to create translation file:
-
-* Navigate to `django-queuebie`
-* `python manage.py makemessages -l de`
-* Have a look at the new/changed files within `queuebie/locale`
-
-How to compile translation files:
-
-* Navigate to `django-queuebie`
-* `python manage.py compilemessages`
-* Have a look at the new/changed files within `queuebie/locale`
-
+```python
+INSTALLED_APPS = (
+    # ...
+    "queuebie",
+)
+```
 
 ### Publish to ReadTheDocs.io
 
@@ -217,27 +144,43 @@ How to compile translation files:
 - Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD) if the GitHub webhook is not yet set
   up.
 
-### Publish to PyPi
+### Preparation and building
+
+This package uses [uv](https://github.com/astral-sh/uv) for dependency management and building.
 
 - Update documentation about new/changed functionality
 
-- Update the `Changelog`
+- Update the `CHANGES.md`
 
 - Increment version in main `__init__.py`
 
-- Create pull request / merge to main
+- Create pull request / merge to "main"
 
-- This project uses the flit package to publish to PyPI. Thus, publishing should be as easy as running:
-  ```
-  flit publish
+- This project uses uv to publish to PyPI. This will create distribution files in the `dist/` directory.
+
+  ```bash
+  uv build
   ```
 
-  To publish to TestPyPI use the following to ensure that you have set up your .pypirc as
-  shown [here](https://flit.readthedocs.io/en/latest/upload.html#using-pypirc) and use the following command:
+### Publishing to PyPI
 
-  ```
-  flit publish --repository testpypi
-  ```
+To publish to the production PyPI:
+
+```bash
+uv publish
+```
+
+To publish to TestPyPI first (recommended for testing):
+
+```bash
+uv publish --publish-url https://test.pypi.org/legacy/
+```
+
+You can then test the installation from TestPyPI:
+
+```bash
+uv pip install --index-url https://test.pypi.org/simple/ ambient-package-update
+```
 
 ### Maintenance
 
@@ -247,5 +190,3 @@ configuration and setup files. It works similar to well-known updaters like `pyu
 
 To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/)
 of the "ambient-package-update".
-
-

django_queuebie-0.3.6/README.md

@@ -0,0 +1,138 @@
+[![PyPI release](https://img.shields.io/pypi/v/django-queuebie.svg)](https://pypi.org/project/django-queuebie/)
+[![Downloads](https://static.pepy.tech/badge/django-queuebie)](https://pepy.tech/project/django-queuebie)
+[![Coverage](https://img.shields.io/badge/Coverage-100.0%25-success)](https://github.com/ambient-innovation/django-queuebie/actions?workflow=CI)
+[![Linting](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Coding Style](https://img.shields.io/badge/code%20style-Ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Documentation Status](https://readthedocs.org/projects/django-queuebie/badge/?version=latest)](https://django-queuebie.readthedocs.io/en/latest/?badge=latest)
+
+A simple and synchronous message queue for commands and events for Django.
+
+[PyPI](https://pypi.org/project/django-queuebie/) | [GitHub](https://github.com/ambient-innovation/django-queuebie) | [Full documentation](https://django-queuebie.readthedocs.io/en/latest/index.html)
+
+Creator & Maintainer: [Ambient Digital](https://ambient.digital/)
+
+## Features
+
+* Split up your business logic in commands and events
+* Commands are imperatives telling your system what to do, events reflect that something has happened
+* Register light-weight functions via a decorator to listen to your commands and events
+* Message handlers receive the context of the message (command or event), providing an explicit API
+* No magic, no side effects since the queue works synchronously
+
+```python
+import dataclasses
+
+from queuebie.runner import handle_message
+from queuebie.messages import Command, Event
+from queuebie import message_registry
+
+
+# Example command
+@dataclasses.dataclass(kw_only=True)
+class BuyProduct(Command):
+    product_id: int
+    customer_id: int
+    price: float
+    currency: str
+
+
+# Example event
+@dataclasses.dataclass(kw_only=True)
+class ProductBought(Event):
+    product_id: int
+    customer_id: int
+
+
+# Example handler
+@message_registry.register_command(BuyProduct)
+def handle_buy_product(context: BuyProduct) -> Event:
+    # Here lives your business logic
+
+    return ProductBought(
+        product_id=context.product_id,
+        customer_id=context.customer_id,
+    )
+
+
+# Start queue and process messages
+handle_message(
+    BuyProduct(
+        product_id=product.id,
+        customer_id=customer.id,
+        price=12.99,
+        currency="EUR",
+    )
+)
+```
+
+## Installation
+
+- Install the package via pip:
+
+  `pip install django_queuebie`
+
+  or via uv:
+
+  `uv add django_queuebie`
+
+- Add module to `INSTALLED_APPS` within the main django `settings.py`:
+
+```python
+INSTALLED_APPS = (
+    # ...
+    "queuebie",
+)
+```
+
+### Publish to ReadTheDocs.io
+
+- Fetch the latest changes in GitHub mirror and push them
+- Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD) if the GitHub webhook is not yet set
+  up.
+
+### Preparation and building
+
+This package uses [uv](https://github.com/astral-sh/uv) for dependency management and building.
+
+- Update documentation about new/changed functionality
+
+- Update the `CHANGES.md`
+
+- Increment version in main `__init__.py`
+
+- Create pull request / merge to "main"
+
+- This project uses uv to publish to PyPI. This will create distribution files in the `dist/` directory.
+
+  ```bash
+  uv build
+  ```
+
+### Publishing to PyPI
+
+To publish to the production PyPI:
+
+```bash
+uv publish
+```
+
+To publish to TestPyPI first (recommended for testing):
+
+```bash
+uv publish --publish-url https://test.pypi.org/legacy/
+```
+
+You can then test the installation from TestPyPI:
+
+```bash
+uv pip install --index-url https://test.pypi.org/simple/ ambient-package-update
+```
+
+### Maintenance
+
+Please note that this package supports the [ambient-package-update](https://pypi.org/project/ambient-package-update/).
+So you don't have to worry about the maintenance of this package. This updater is rendering all important
+configuration and setup files. It works similar to well-known updaters like `pyupgrade` or `django-upgrade`.
+
+To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/)
+of the "ambient-package-update".

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/SECURITY.md

@@ -4,7 +4,7 @@ The maintainers of this package take security bugs seriously. We appreciate your
 disclose your findings, and will make every effort to acknowledge your contributions.
 
 To report a security issue, please use the GitHub Security
-Advisory ["Report a Vulnerability"](https://github.com/ambient-innovation/django-queuebie/security/advisories/new) 
+Advisory ["Report a Vulnerability"](https://github.com/ambient-innovation/django-queuebie/security/advisories/new)
 tab.
 
 The maintainers will send a response indicating the next steps in handling your report. After the initial reply to

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/docs/conf.py

@@ -62,7 +62,6 @@ templates_path = ["_templates"]
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

{django_queuebie-0.3.3 → django_queuebie-0.3.6}/manage.py

@@ -9,7 +9,7 @@ def main():
     """Run administrative tasks."""
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
     try:
-        from django.core.management import execute_from_command_line
+        from django.core.management import execute_from_command_line  # noqa: PLC0415
     except ImportError as exc:
         raise ImportError(  # noqa: TRY003
             "Couldn't import Django. Are you sure it's installed and "