{"id":18948843,"url":"https://github.com/freonius/coleridge","last_synced_at":"2025-10-09T11:14:51.352Z","repository":{"id":253933413,"uuid":"844892349","full_name":"Freonius/coleridge","owner":"Freonius","description":"A clean RabbitMQ decorator","archived":false,"fork":false,"pushed_at":"2025-02-13T10:35:36.000Z","size":75,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T03:18:59.543Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Freonius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":"LICENSE","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},"funding":{"github":"freonius"}},"created_at":"2024-08-20T07:06:32.000Z","updated_at":"2025-02-13T10:35:39.000Z","dependencies_parsed_at":"2024-08-21T03:31:33.731Z","dependency_job_id":null,"html_url":"https://github.com/Freonius/coleridge","commit_stats":null,"previous_names":["freonius/coleridge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freonius%2Fcoleridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freonius%2Fcoleridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freonius%2Fcoleridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freonius%2Fcoleridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Freonius","download_url":"https://codeload.github.com/Freonius/coleridge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239946916,"owners_count":19723018,"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","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":[],"created_at":"2024-11-08T13:14:51.301Z","updated_at":"2025-10-09T11:14:46.307Z","avatar_url":"https://github.com/Freonius.png","language":"Python","funding_links":["https://github.com/sponsors/freonius"],"categories":[],"sub_categories":[],"readme":"# Coleridge\n\nUse Pydantic with RabbitMQ or to run background tasks.\n\n## Example\n\n```python\nfrom time import sleep\nfrom pydantic import BaseModel\nfrom coleridge import Coleridge, Empty, Connection\n\nclass Poem(BaseModel):\n    lines: List[str]\n\n\n# Background task\ncoleridge = Coleridge()\n\n@coleridge\ndef long_task(_: Empty) -\u003e Poem:\n    poem = Poem(lines=[\"In Xanadu did Kubla Khan\",\n            \"A stately pleasure-dome decree:\",])\n    sleep(5)\n    return poem\n\ndef print_poem(poem: Poem) -\u003e None:\n    for line in poem.lines:\n        print(f\"~~ {line} ~~\")\n\ndef print_error(error: Exception) -\u003e None:\n    print(error)\n\n# Assing a function to run when the exection finishes\nlong_task.on_finish = print_poem\n\n# Or catch errors\nlong_task.on_error = print_error\n\n# Run the task\nlong_task.run(Empty()) # It always requires a pydantic model, empty in this case\n\n\n# Or use RabbitMQ instead of background functions\nrabbit = Coleridge(Connection(host=\"localhost\", port=5672))\n\n@rabbit\ndef long_task_with_rabbit(poem: Poem) -\u003e Empty:\n    for line in poem.lines:\n        print(f\"~~ {line} ~~\")\n        sleep(5)\n    return Empty()\n\nlong_task_with_rabbit.run(Poem(lines=[\"In Xanadu did Kubla Khan\",\n            \"A stately pleasure-dome decree:\",]))\n\n\n```\n\nYou can also call the results directly like this:\n\n```python\nfrom time import sleep\nfrom pydantic import BaseModel\nfrom coleridge import Coleridge, Empty, Connection\n\nclass Poem(BaseModel):\n    lines: List[str]\n\n\n# Background task\ncoleridge = Coleridge()\n\n@coleridge\ndef long_task(_: Empty) -\u003e Poem:\n    poem = Poem(lines=[\"In Xanadu did Kubla Khan\",\n            \"A stately pleasure-dome decree:\",])\n    sleep(5)\n    return poem\n\nresult = long_task.run(Empty())\n\nwhile True:\n    if result.finished:\n        if result.success:\n            print(result.result)\n        elif result.error:\n            print(result.error)\n        break\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreonius%2Fcoleridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreonius%2Fcoleridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreonius%2Fcoleridge/lists"}