{"id":19745728,"url":"https://github.com/taskiq-python/taskiq-nats","last_synced_at":"2025-10-24T19:14:57.063Z","repository":{"id":142761506,"uuid":"614107986","full_name":"taskiq-python/taskiq-nats","owner":"taskiq-python","description":"NATS broker and result backend for taskiq","archived":false,"fork":false,"pushed_at":"2024-11-06T18:44:16.000Z","size":213,"stargazers_count":26,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-22T18:40:22.642Z","etag":null,"topics":["asyncio","nats","python3","taskiq","taskiq-broker"],"latest_commit_sha":null,"homepage":"https://taskiq-python.github.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taskiq-python.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-14T22:55:52.000Z","updated_at":"2025-09-22T06:45:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"eb628e50-d830-422c-8bfc-f5c002f631d9","html_url":"https://github.com/taskiq-python/taskiq-nats","commit_stats":{"total_commits":65,"total_committers":5,"mean_commits":13.0,"dds":0.4,"last_synced_commit":"c98d84819052dd682b92f1d62b861441fc1823d7"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/taskiq-python/taskiq-nats","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-nats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-nats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-nats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-nats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taskiq-python","download_url":"https://codeload.github.com/taskiq-python/taskiq-nats/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-nats/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280851687,"owners_count":26402234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","nats","python3","taskiq","taskiq-broker"],"created_at":"2024-11-12T02:11:04.278Z","updated_at":"2025-10-24T19:14:57.001Z","avatar_url":"https://github.com/taskiq-python.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Taskiq NATS\n\nTaskiq-nats is a plugin for taskiq that adds NATS broker.\nThis package has support for NATS JetStream.\n\n## Installation\n\nTo use this project you must have installed core taskiq library:\n\n```bash\npip install taskiq taskiq-nats\n```\n\n## Usage\n\nHere's a minimal setup example with a broker and one task.\n\n### Default NATS broker.\n```python\nimport asyncio\nfrom taskiq_nats import NatsBroker, JetStreamBroker\n\nbroker = NatsBroker(\n    [\n        \"nats://nats1:4222\",\n        \"nats://nats2:4222\",\n    ],\n    queue=\"random_queue_name\",\n)\n\n\n@broker.task\nasync def my_lovely_task():\n    print(\"I love taskiq\")\n\n\nasync def main():\n    await broker.startup()\n\n    await my_lovely_task.kiq()\n\n    await broker.shutdown()\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n\n```\n### NATS broker based on JetStream\n```python\nimport asyncio\nfrom taskiq_nats import (\n    PushBasedJetStreamBroker,\n    PullBasedJetStreamBroker\n)\n\nbroker = PushBasedJetStreamBroker(\n    servers=[\n        \"nats://nats1:4222\",\n        \"nats://nats2:4222\",\n    ],\n    queue=\"awesome_queue_name\",\n)\n\n# Or you can use pull based variant\nbroker = PullBasedJetStreamBroker(\n    servers=[\n        \"nats://nats1:4222\",\n        \"nats://nats2:4222\",\n    ],\n    durable=\"awesome_durable_consumer_name\",\n)\n\n\n@broker.task\nasync def my_lovely_task():\n    print(\"I love taskiq\")\n\n\nasync def main():\n    await broker.startup()\n\n    await my_lovely_task.kiq()\n\n    await broker.shutdown()\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## NatsBroker configuration\n\nHere's the constructor parameters:\n\n* `servers` - a single string or a list of strings with nats nodes addresses.\n* `subject` - name of the subect that will be used to exchange tasks betwee workers and clients.\n* `queue` - optional name of the queue. By default NatsBroker broadcasts task to all workers,\n    but if you want to handle every task only once, you need to supply this argument.\n* `result_backend` - custom result backend.\n* `task_id_generator` - custom function to generate task ids.\n* Every other keyword argument will be sent to `nats.connect` function.\n\n## JetStreamBroker configuration\n### Common\n* `servers` - a single string or a list of strings with nats nodes addresses.\n* `subject` - name of the subect that will be used to exchange tasks betwee workers and clients.\n* `stream_name` - name of the stream where subjects will be located.\n* `queue` - a single string or a list of strings with nats nodes addresses.\n* `result_backend` - custom result backend.\n* `task_id_generator` - custom function to generate task ids.\n* `stream_config` - a config for stream.\n* `consumer_config` - a config for consumer.\n\n### PushBasedJetStreamBroker\n* `queue` - name of the queue. It's used to share messages between different consumers.\n\n### PullBasedJetStreamBroker\n* `durable` - durable name of the consumer. It's used to share messages between different consumers.\n* `pull_consume_batch` - maximum number of message that can be fetched each time.\n* `pull_consume_timeout` - timeout for messages fetch. If there is no messages, we start fetching messages again.\n\n\n## NATS Result Backend\nIt's possible to use NATS JetStream to store tasks result.\n```python\nimport asyncio\nfrom taskiq_nats import PullBasedJetStreamBroker\nfrom taskiq_nats.result_backend import NATSObjectStoreResultBackend\n\n\nresult_backend = NATSObjectStoreResultBackend(\n    servers=\"localhost\",\n)\nbroker = PullBasedJetStreamBroker(\n    servers=\"localhost\",\n).with_result_backend(\n    result_backend=result_backend,\n)\n\n\n@broker.task\nasync def awesome_task() -\u003e str:\n    return \"Hello, NATS!\"\n\n\nasync def main() -\u003e None:\n    await broker.startup()\n    task = await awesome_task.kiq()\n    res = await task.wait_result()\n    print(res)\n    await broker.shutdown()\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskiq-python%2Ftaskiq-nats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaskiq-python%2Ftaskiq-nats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskiq-python%2Ftaskiq-nats/lists"}