From c40a4a79e9dce998eee04030ddd99eb88e5abfed Mon Sep 17 00:00:00 2001 From: Anfimov Dima Date: Mon, 25 Aug 2025 12:47:50 +0200 Subject: [PATCH] docs: add list of third-party result backends and brokers --- docs/available-components/brokers.md | 33 ++++++++++++- docs/available-components/result-backends.md | 49 ++++++++++++++++++-- 2 files changed, 77 insertions(+), 5 deletions(-) diff --git a/docs/available-components/brokers.md b/docs/available-components/brokers.md index d3bc555d..c4dad6df 100644 --- a/docs/available-components/brokers.md +++ b/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 +``` diff --git a/docs/available-components/result-backends.md b/docs/available-components/result-backends.md index 69aa02c4..d5fdcd4a 100644 --- a/docs/available-components/result-backends.md +++ b/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 +```