Merge branch 'master' of https://github.com/taskiq-python/taskiq

Author: WiZeYAR

.github/workflows/release.yml

@@ -9,17 +9,19 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
       - name: Install poetry
         run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
       - name: Install deps
         run: poetry install
       - name: Set version
-        run: poetry version "${{ github.ref_name }}"
+        run: poetry version "${GITHUB_REF_NAME}"
       - name: Release package
         env:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}

.github/workflows/release_docs.yaml

@@ -13,11 +13,13 @@ jobs:
   deploy_docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
           node-version: 18
           cache: pnpm
@@ -31,7 +33,7 @@ jobs:
           git config --global lfs.allowincompletepush true
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           personal_token: ${{ secrets.PERSONAL_TOKEN }}
           external_repository: taskiq-python/taskiq-python.github.io

.github/workflows/test.yml

@@ -2,7 +2,18 @@ name: Testing taskiq
 
 on:
   pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
   push:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+
+permissions:
+  actions: read
+  contents: read
+  pull-requests: read
 
 jobs:
   lint:
@@ -14,11 +25,13 @@ jobs:
           - mypy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
       - name: Install poetry
         run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
           cache: "poetry"
@@ -34,11 +47,13 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: "${{ matrix.os }}"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
       - name: Install poetry
         run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: "${{ matrix.py_version }}"
           cache: "poetry"

.pre-commit-config.yaml

@@ -2,18 +2,33 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
       - id: trailing-whitespace
       - id: check-toml
       - id: end-of-file-fixer
 
   - repo: https://github.com/asottile/add-trailing-comma
-    rev: v2.1.0
+    rev: v4.0.0
     hooks:
       - id: add-trailing-comma
 
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.38.1
+    hooks:
+      - id: typos
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+    -   id: detect-secrets
+        args: [
+            '--exclude-files', 'pnpm-lock.yaml',
+            '--exclude-files', 'docs/README.md',
+            '--exclude-lines', 'amqp://guest:guest@localhost:5672',
+        ]
+
   - repo: local
     hooks:
       - id: black

docs/available-components/brokers.md

@@ -82,7 +82,8 @@ await my_task.kicker().with_broker(broker).kiq()
 
 ## Custom brokers
 
-These brokers are not parts of the core taskiq lib. You can install them as a separate packages.
+These brokers are not parts of the core Taskiq lib. But they are maintained by Taskiq developers.
+You can install them as a separate packages.
 
 You can read more about parameters and abilities of these brokers in README.md of each repo.
 
@@ -110,3 +111,33 @@ Project link: [taskiq-nats](https://github.com/taskiq-python/taskiq-nats).
 ```bash
 pip install taskiq-nats
 ```
+
+## Third-party brokers
+
+These brokers are not part of the core Taskiq library. They are maintained by other open‑source contributors. You can install them as a separate packages.
+
+You can read more about parameters and abilities of these brokers in README.md of each repo.
+
+### PostgreSQL broker
+
+Project link: [taskiq-postgresql](https://github.com/z22092/taskiq-postgresql).
+
+```bash
+pip install taskiq-postgresql
+```
+
+### SQS broker
+
+Project link: [taskiq-aio-sqs](https://github.com/vonsteer/taskiq-aio-sqs).
+
+```bash
+pip install taskiq-aio-sqs
+```
+
+### YDB broker
+
+Project link: [taskiq-ydb](https://github.com/danfimov/taskiq-ydb).
+
+```bash
+pip install taskiq-ydb
+```

docs/available-components/result-backends.md

@@ -10,19 +10,60 @@ This includes:
 - return value;
 - Execution time in seconds.
 
-## DummyResultBackend
+## Built-in result backends
+
+### DummyResultBackend
 
 This result backend doesn't do anything. It doesn't store results and cannot be used in cases,
 where you need actual results.
 
 This broker will always return `None` for any return_value. Please be careful.
 
-## Redis result backend
 
-This result backend is not part of the core taskiq library. You can install it as a separate package [taskiq-redis](https://pypi.org/project/taskiq-redis/).
+## Official result backends
+
+This result backends is not part of the core Taskiq library. But they are maintained by Taskiq developers. You can install them as a separate package.
+
+### Redis result backend
+
+Project link: [taskiq-redis](https://pypi.org/project/taskiq-redis/).
 
 ```bash
 pip install taskiq-redis
 ```
 
-You can read more about parameters and abilities of this broker in [README.md](https://github.com/taskiq-python/taskiq-redis).
+### NATS result backend
+
+Project link: [taskiq-nats](https://github.com/taskiq-python/taskiq-nats).
+
+```bash
+pip install taskiq-nats
+```
+
+## Third-party result backends
+
+These result backends are not part of the core Taskiq library. They are maintained by other open‑source contributors. You can install them as a separate packages.
+
+### PostgreSQL result backend
+
+Project link: [taskiq-postgresql](https://github.com/z22092/taskiq-postgresql).
+
+```bash
+pip install taskiq-postgresql
+```
+
+### S3 result backend
+
+Project link: [taskiq-aio-sqs](https://github.com/vonsteer/taskiq-aio-sqs).
+
+```bash
+pip install taskiq-aio-sqs
+```
+
+### YDB result backend
+
+Project link: [taskiq-ydb](https://github.com/danfimov/taskiq-ydb).
+
+```bash
+pip install taskiq-ydb
+```

docs/available-components/schedule-sources.md

@@ -5,9 +5,12 @@ order: 4
 # Available schedule sources
 
 These objects are used to fetch current schedule for tasks.
-Currently we have only one schedule source.
 
-## RedisScheduleSource
+## Official schedule sources
+
+These schedule sources are not part of the core Taskiq library. But they are maintained by Taskiq developers. You can install them as a separate package.
+
+### RedisScheduleSource
 
 This source is capable of adding new schedules in runtime. It uses Redis as a storage for schedules.
 To use this source you need to install `taskiq-redis` package.
@@ -24,7 +27,7 @@ scheduler = TaskiqScheduler(broker, sources=[redis_source])
 For more information on how to use dynamic schedule sources read [Dynamic scheduling section](../guide/scheduling-tasks.md#dynamic-scheduling).
 
 
-## LabelScheduleSource
+### LabelScheduleSource
 
 This source parses labels of tasks, and if it finds a `schedule` label, it considers this task as scheduled.
 
@@ -34,12 +37,13 @@ The format of the schedule label is the following:
 @broker.task(
     schedule=[
         {
-            "cron": "* * * * *", # type: str, either cron or time should be specified.
+            "cron": "*/1 * * * *", # type: str, either cron or time should be specified.
             "cron_offset": None # type: str | timedelta | None, can be omitted.
             "time": None  # type: datetime | None, either cron or time should be specified.
             "args": [], # type List[Any] | None, can be omitted.
             "kwargs": {}, # type: Dict[str, Any] | None, can be omitted.
             "labels": {}, # type: Dict[str, Any] | None, can be omitted.
+            "schedule_id": "every_minute",  # type: str | None, can be omitted.
         }
     ]
 )
@@ -55,6 +59,7 @@ Parameters:
 - `args` - args to use, when invoking the task.
 - `kwargs` - key-word arguments to use when invoking the task.
 - `labels` - additional labels to use when invoking the task.
+- `schedule_id` - unique identifier of the schedule. If not specified, a random uuid will be generated.
 
 To enable this source, just add it to the list of sources:
 
@@ -76,3 +81,43 @@ In order to resolve all labels correctly, don't forget to import
 all task modules using CLI interface.
 
 :::
+
+### NATS schedule source
+
+This source is capable of adding new schedules in runtime. It uses NATS as a storage for schedules.
+To use this source you need to install `taskiq-nats` package.
+
+```python
+from taskiq_nats import NATSKeyValueScheduleSource
+from taskiq.scheduler import TaskiqScheduler
+
+
+broker = ...
+
+scheduler = TaskiqScheduler(
+    broker=broker,
+    sources=[NATSKeyValueScheduleSource(broker)],
+)
+```
+
+This schedule source doesn't use `schedule` label on tasks. To add new schedules, you need to call `add_schedule` method on the source.
+
+## Third-party schedule sources
+
+These schedule sources are not part of the core Taskiq library. They are maintained by other open‑source contributors. You can install them as a separate packages.
+
+### PostgreSQL schedule source
+
+Project link: [taskiq-postgres](https://github.com/danfimov/taskiq-postgres)
+
+```bash
+pip install taskiq-postgres
+```
+
+### YDB schedule source
+
+Project link: [taskiq-ydb](https://github.com/danfimov/taskiq-ydb)
+
+```bash
+pip install taskiq-ydb
+```

docs/extending-taskiq/schedule-sources.md

@@ -12,3 +12,8 @@ Here's a minimal example of a schedule source:
 @[code python](../examples/extending/schedule_source.py)
 
 You can implement a schedule source that write schedules in the database and have delayed tasks in runtime.
+
+::: info Cool tip!
+You can also use `LabelScheduleSource` as a base class for your schedule source
+if you want to parse schedules from task labels and don't want to implement logic for this from scratch.
+:::

docs/guide/README.md

@@ -21,18 +21,18 @@ We created this project because we couldn't find any project that can execute an
 
 You might have seen projects built on top of asyncio that solve a similar problem, but here's a comparison table of the taskiq and other projects.
 
-|                Feature name | Taskiq |  Arq  | AioTasks |
-| --------------------------: | :----: | :---: | :------: |
-|         Actively maintained |   ✅    |   ✅   |    ❌     |
-|    Multiple broker backends |   ✅    |   ❌   |    ✅     |
-|    Multiple result backends |   ✅    |   ❌   |    ❌     |
-|  Have a rich documentation  |   ✅    |   ❌   |    ❌     |
-|   Startup & Shutdown events |   ✅    |   ✅   |    ❌     |
-| Have ability to abort tasks |   ❌    |   ✅   |    ❌     |
-|          Custom serializers |   ✅    |   ✅   |    ❌     |
-|        Dependency injection |   ✅    |   ❌   |    ❌     |
-|              Task pipelines |   ✅    |   ✅   |    ❌     |
-|              Task schedules |   ✅    |   ✅   |    ❌     |
-|          Global middlewares |   ✅    |   ❌   |    ❌     |
+|                Feature name | Taskiq |  Arq  | AioTasks | streaQ |
+| --------------------------: | :----: | :---: | :------: | :----: |
+|         Actively maintained |   ✅    |   ✅   |    ❌     |   ✅   |
+|    Multiple broker backends |   ✅    |   ❌   |    ✅     |   ❌   |
+|    Multiple result backends |   ✅    |   ❌   |    ❌     |   ❌   |
+|  Have a rich documentation  |   ✅    |   ❌   |    ❌     |   ✅   |
+|   Startup & Shutdown events |   ✅    |   ✅   |    ❌     |   ✅   |
+| Have ability to abort tasks |   ❌    |   ✅   |    ❌     |   ✅   |
+|          Custom serializers |   ✅    |   ✅   |    ❌     |   ✅   |
+|        Dependency injection |   ✅    |   ❌   |    ❌     |   ❌   |
+|              Task pipelines |   ✅    |   ✅   |    ❌     |   ✅   |
+|              Task schedules |   ✅    |   ✅   |    ❌     |   ✅   |
+|          Global middlewares |   ✅    |   ❌   |    ❌     |   ✅   |
 
 If you have a fully synchronous project, consider using celery or dramatiq instead.

docs/guide/scheduling-tasks.md

@@ -53,6 +53,12 @@ The scheduler doesn't execute tasks. It only sends them.
 
 You can check list of available schedule sources in the [Available schedule sources](../available-components/schedule-sources.md) section.
 
+::: tip Cool tip!
+
+To specify schedules (cron or time-based) in the labels of a task definition, you must include **LabelScheduleSource** along with any other sources you use (e.g., **ListRedisScheduleSource**).
+
+:::
+
 ## Multiple sources
 
 Sometimes you may want to use multiple sources to assemble a schedule for tasks. The `TaskiqScheduler` can do so.