celery-yaml 2.2.0__tar.gz → 2.2.2__tar.gz

{celery_yaml-2.2.0 → celery_yaml-2.2.2}/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.2.2 - Released on 2026-08-28
+* Use alternatives method to crash the process if the yaml is invalid. 
+
+## 2.2.1 - Released on 2026-04-29
+* Log exception in case yaml file is invalid, because celery eat it.
+* Update releasing script 
+
 ## 2.2.0 - Released on 2025-04-17
 * Implement crontab for schedule. 
 

{celery_yaml-2.2.0 → celery_yaml-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: celery-yaml
-Version: 2.2.0
+Version: 2.2.2
 Summary: Easy configuration for celery app using Yaml file
 Author-Email: Guillaume Gauvrit <guillaume@gauvr.it>
 License: BSD
@@ -13,6 +13,9 @@ Requires-Python: >=3.9
 Requires-Dist: celery<6,>=5.4.0
 Requires-Dist: pyyaml<7,>=6.0.0
 Requires-Dist: envsub<1,>=0.1.15
+Provides-Extra: pyramid
+Requires-Dist: pyramid<3,>=1.9; extra == "pyramid"
+Requires-Dist: plaster-yaml<3,>=2.0; extra == "pyramid"
 Description-Content-Type: text/markdown
 
 [![Continuous Integration](https://github.com/mardiros/celery-yaml/actions/workflows/tests.yml/badge.svg)](https://github.com/mardiros/celery-yaml/actions/workflows/tests.yml)
@@ -25,14 +28,12 @@ command in order to inject its configuration.
 
 It also handle help to configurate this application for Pyramid application.
 
-
 ## Usage
 
 ```sh
 celery -A my_application.module_containing_my.app worker --yaml development.yaml ...
 ```
 
-
 This will configure the application `my_application` containing an application
 `app` in a submodule `module_containing_my`.
 
@@ -51,10 +52,10 @@ add_yaml_option(app)
 
 ```yaml
 celery:
-  broker_url: 'amqp://guest:guest@localhost:5672//'
-  result_backend: 'rpc://'
+  broker_url: "amqp://guest:guest@localhost:5672//"
+  result_backend: "rpc://"
   imports:
-      - my_application.tasks
+    - my_application.tasks
   # see all settings in the celery docs:
   # https://docs.celeryproject.org/en/stable/userguide/configuration.html
 
@@ -65,26 +66,71 @@ logging:
 ```
 
 ---
+
 **NOTE**
 
-The broker_url can also be override by an environment variable `CELERY_BROKER_URL`
-to avoid password in the configuration file.
+To **avoid password in** the **configuration file**:
+
+- Every variables can be substitute with an environment variable.
+  The yaml file will replace variable using [envsub](https://mardiros.github.io/envsub/).
+
+  ```yaml
+  celery:
+    broker_url: "${CELERY_BROKER_URL-amqp://guest:guest@localhost:5672//}"
+
+  ```
+
+- **DEPRECATED**: The `broker_url` is always overriden by the environment variable
+  `CELERY_BROKER_URL` without any declaration.
+
 ---
 
+### Using celery beat
+
+Celery beat can schedule tasks using interval or crontab.
+
+The schedule parameter can be an int, a float or a mapping.
+If it is a mapping, it will be cast to a [crontab](https://docs.celeryq.dev/en/stable/reference/celery.schedules.html#celery.schedules.crontab),
+the mapping will be passed as acrontab parameters.
+
+```yaml
+celery:
+  beat_schedule:
+    beat_second:
+      task: beat_it
+      schedule: 10 # example of interval schedule, every 10 seconds
+
+    beat_crontab:
+      task: beat_it
+      schedule: # example of crontab
+        hour: 9
+        minute: 0
+        day_of_week: 1
+```
+
 ## Using Celery in a Pyramid App.
 
 The extras "pyramid" must be added to install the extras depencencies.
 
-### With poetry
+### With PEP 621 (uv, pdm, ...)
 
 ```toml
-[tool.poetry.dependencies]
-celery-yaml = { version = "^0.1.3", extras = ["pyramid"] }
+[dependency-groups]
+celery = ["celery >=5.2.7,<6", "celery-yaml[pyramid]>=2.0.0,<3"]
+
+[project.entry-points."paste.app_factory"]
+main = "pyramid_helloworld:main"
+
+[project.entry-points."celery_yaml.app"]
+main = "pyramid_helloworld.backend:app"
 ```
 
-Then some entry_points have to configure, such as:
+### With poetry
 
 ```toml
+[tool.poetry.dependencies]
+celery-yaml = { version = "^2.0.0", extras = ["pyramid"] }
+
 [tool.poetry.plugins."paste.app_factory"]
 main = "pyramid_app.wsgi:main"
 
@@ -102,14 +148,13 @@ of a yaml file instead of an `ini` file to configure it.
 Then the `celery_yaml.app` is used by `celery-yaml` as an entrypoint to
 the celery app.
 
-
 Then, in the configuration file,
 
 ```yaml
 celery: &celery
-  result_backend: 'rpc://'
+  result_backend: "rpc://"
   imports:
-      - pyramid_app.tasks
+    - pyramid_app.tasks
 
 app:
   "use": "egg:pyramid_app"
@@ -142,7 +187,6 @@ class Celery(CeleryBase):
 
 This is particullary usefull for depenency injection purpose.
 
-
 #### Environment substitution
 
 ```yaml
@@ -150,7 +194,7 @@ celery:
   broker_url: ${CELERY_BROKER_URL}
   result_backend: ${CELERY_BACKEND_RESULT}
   imports:
-      - pyramid_app.tasks
+    - pyramid_app.tasks
 
 database_dsn: ${DATABASE_DSN}
 ```
@@ -164,7 +208,6 @@ This is particullary usefull to keep your configuration structured but keep
 secrets in environment variable, for security reason. And also to build docker
 container that can be easily customizable.
 
-
 #### See full example in the examples directory:
 
 https://github.com/mardiros/celery-yaml/tree/master/examples/pyramid-app

{celery_yaml-2.2.0 → celery_yaml-2.2.2}/README.md

@@ -8,14 +8,12 @@ command in order to inject its configuration.
 
 It also handle help to configurate this application for Pyramid application.
 
-
 ## Usage
 
 ```sh
 celery -A my_application.module_containing_my.app worker --yaml development.yaml ...
 ```
 
-
 This will configure the application `my_application` containing an application
 `app` in a submodule `module_containing_my`.
 
@@ -34,10 +32,10 @@ add_yaml_option(app)
 
 ```yaml
 celery:
-  broker_url: 'amqp://guest:guest@localhost:5672//'
-  result_backend: 'rpc://'
+  broker_url: "amqp://guest:guest@localhost:5672//"
+  result_backend: "rpc://"
   imports:
-      - my_application.tasks
+    - my_application.tasks
   # see all settings in the celery docs:
   # https://docs.celeryproject.org/en/stable/userguide/configuration.html
 
@@ -48,26 +46,71 @@ logging:
 ```
 
 ---
+
 **NOTE**
 
-The broker_url can also be override by an environment variable `CELERY_BROKER_URL`
-to avoid password in the configuration file.
+To **avoid password in** the **configuration file**:
+
+- Every variables can be substitute with an environment variable.
+  The yaml file will replace variable using [envsub](https://mardiros.github.io/envsub/).
+
+  ```yaml
+  celery:
+    broker_url: "${CELERY_BROKER_URL-amqp://guest:guest@localhost:5672//}"
+
+  ```
+
+- **DEPRECATED**: The `broker_url` is always overriden by the environment variable
+  `CELERY_BROKER_URL` without any declaration.
+
 ---
 
+### Using celery beat
+
+Celery beat can schedule tasks using interval or crontab.
+
+The schedule parameter can be an int, a float or a mapping.
+If it is a mapping, it will be cast to a [crontab](https://docs.celeryq.dev/en/stable/reference/celery.schedules.html#celery.schedules.crontab),
+the mapping will be passed as acrontab parameters.
+
+```yaml
+celery:
+  beat_schedule:
+    beat_second:
+      task: beat_it
+      schedule: 10 # example of interval schedule, every 10 seconds
+
+    beat_crontab:
+      task: beat_it
+      schedule: # example of crontab
+        hour: 9
+        minute: 0
+        day_of_week: 1
+```
+
 ## Using Celery in a Pyramid App.
 
 The extras "pyramid" must be added to install the extras depencencies.
 
-### With poetry
+### With PEP 621 (uv, pdm, ...)
 
 ```toml
-[tool.poetry.dependencies]
-celery-yaml = { version = "^0.1.3", extras = ["pyramid"] }
+[dependency-groups]
+celery = ["celery >=5.2.7,<6", "celery-yaml[pyramid]>=2.0.0,<3"]
+
+[project.entry-points."paste.app_factory"]
+main = "pyramid_helloworld:main"
+
+[project.entry-points."celery_yaml.app"]
+main = "pyramid_helloworld.backend:app"
 ```
 
-Then some entry_points have to configure, such as:
+### With poetry
 
 ```toml
+[tool.poetry.dependencies]
+celery-yaml = { version = "^2.0.0", extras = ["pyramid"] }
+
 [tool.poetry.plugins."paste.app_factory"]
 main = "pyramid_app.wsgi:main"
 
@@ -85,14 +128,13 @@ of a yaml file instead of an `ini` file to configure it.
 Then the `celery_yaml.app` is used by `celery-yaml` as an entrypoint to
 the celery app.
 
-
 Then, in the configuration file,
 
 ```yaml
 celery: &celery
-  result_backend: 'rpc://'
+  result_backend: "rpc://"
   imports:
-      - pyramid_app.tasks
+    - pyramid_app.tasks
 
 app:
   "use": "egg:pyramid_app"
@@ -125,7 +167,6 @@ class Celery(CeleryBase):
 
 This is particullary usefull for depenency injection purpose.
 
-
 #### Environment substitution
 
 ```yaml
@@ -133,7 +174,7 @@ celery:
   broker_url: ${CELERY_BROKER_URL}
   result_backend: ${CELERY_BACKEND_RESULT}
   imports:
-      - pyramid_app.tasks
+    - pyramid_app.tasks
 
 database_dsn: ${DATABASE_DSN}
 ```
@@ -147,7 +188,6 @@ This is particullary usefull to keep your configuration structured but keep
 secrets in environment variable, for security reason. And also to build docker
 container that can be easily customizable.
 
-
 #### See full example in the examples directory:
 
 https://github.com/mardiros/celery-yaml/tree/master/examples/pyramid-app

{celery_yaml-2.2.0 → celery_yaml-2.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "celery-yaml"
-version = "2.2.0"
+version = "2.2.2"
 description = "Easy configuration for celery app using Yaml file"
 authors = [
     { name = "Guillaume Gauvrit", email = "guillaume@gauvr.it" },
@@ -23,19 +23,22 @@ Repository = "https://github.com/mardiros/celery-yaml.git"
 Issues = "https://github.com/mardiros/celery-yaml/issues"
 Changelog = "https://github.com/mardiros/celery-yaml/blob/main/CHANGELOG.md"
 
+[project.optional-dependencies]
+pyramid = [
+    "pyramid >=1.9,<3",
+    "plaster-yaml >=2.0,<3",
+]
+
 [dependency-groups]
 dev = [
-    "celery>=5.2.0,<6",
-    "coverage>=6.2,<7",
-    "mypy>=1.13.0,<2",
-    "pytest>=8.3.3,<9",
-    "pytest-cov>=5.0.0,<6",
-    "pyramid-helloworld>=2.0.0",
-    "types-pyyaml>=6.0.12.20240917,<7",
-]
-pyramid = [
-    "pyramid>=1.9,<3",
-    "plaster-yaml>=2.0,<3",
+    "celery >=5.2.0,<6",
+    "coverage >=6.2,<7",
+    "mypy >=1.13.0,<2",
+    "pyramid >=1.9,<3",
+    "pytest >=8.3.3,<9",
+    "pytest-cov >=5.0.0,<6",
+    "pyramid-helloworld >=2.0.0,<3",
+    "types-pyyaml >=6.0.12.20240917,<7",
 ]
 
 [tool.pdm.build]

{celery_yaml-2.2.0 → celery_yaml-2.2.2}/src/celery_yaml/loader.py

@@ -3,6 +3,7 @@
 import logging
 import os
 import sys
+import traceback
 from collections.abc import Iterator, Mapping
 from logging.config import dictConfig
 from typing import Any, Tuple
@@ -28,8 +29,12 @@ def on_preload_parsed(options: Mapping[str, Any], **kwargs: Any) -> None:
         print("You must provide the --yaml argument")
         sys.exit(-1)
 
-    loader = YamlLoader(app, config=config_path, config_key=config_key)
-    loader.read_configuration()
+    try:
+        loader = YamlLoader(app, config=config_path, config_key=config_key)
+        loader.read_configuration()
+    except Exception:
+        traceback.print_exc()
+        sys.exit(1)
 
 
 def add_yaml_option(app: Celery) -> None: