{"id":13415986,"url":"https://github.com/rajasimon/beatserver","last_synced_at":"2026-04-05T17:42:02.089Z","repository":{"id":43175131,"uuid":"63627605","full_name":"rajasimon/beatserver","owner":"rajasimon","description":"Beatserver, a periodic task scheduler for Django 🎵","archived":false,"fork":false,"pushed_at":"2022-12-04T19:02:38.000Z","size":168,"stargazers_count":141,"open_issues_count":0,"forks_count":20,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-10-14T04:45:56.041Z","etag":null,"topics":["channels","django","django-channels","python","scheduler","task","websocket"],"latest_commit_sha":null,"homepage":"https://rajasimon.io/django-channels-background-task/","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/rajasimon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-18T18:36:16.000Z","updated_at":"2024-09-30T12:38:48.000Z","dependencies_parsed_at":"2023-01-22T23:30:18.357Z","dependency_job_id":null,"html_url":"https://github.com/rajasimon/beatserver","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajasimon%2Fbeatserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajasimon%2Fbeatserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajasimon%2Fbeatserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajasimon%2Fbeatserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rajasimon","download_url":"https://codeload.github.com/rajasimon/beatserver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243663466,"owners_count":20327299,"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":["channels","django","django-channels","python","scheduler","task","websocket"],"created_at":"2024-07-30T21:00:53.481Z","updated_at":"2025-12-13T21:05:46.188Z","avatar_url":"https://github.com/rajasimon.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"logo/horizontalversions.png\" alt=\"beatserver\" height=\"150px\"\u003e\u003c/p\u003e\n\n# Beat Server\n\n[![Build Status](https://travis-ci.org/rajasimon/beatserver.svg?branch=master)](https://travis-ci.org/rajasimon/beatserver)\n[![PyPI version](https://badge.fury.io/py/beatserver.svg)](https://badge.fury.io/py/beatserver)\n\nBeatserver, a periodic task scheduler for django channels | beta software\n\n### How to install\n\n#### Prerequirements:\n\nFollow django channels documentation on howto install channels.\n\n#### Install beatserver:\n\n```shell\npip install -U beatserver\n```\n\n### Configurations:\n\nAdd `beatserver` to `INSTALLED_APPS` in **settings.py**:\n\n```python\nINSTALLED_APPS = [\n    'beatserver',\n    'channels',\n    '...'\n]\n```\n\n\n**beatconfig.py**\n\n```python\nfrom datetime import timedelta\n\nBEAT_SCHEDULE = {\n    'testing-print': [\n        {\n            # will call test_print method of PrintConsumer\n            'type': 'test.print',\n            # message to pass to the consumer\n            'message': {'testing': 'one'},\n            # Every 5 seconds\n            'schedule': timedelta(seconds=5)\n        },\n        {\n            'type': 'test.print',\n            'message': {'testing': 'two'},\n            # Precisely at 3AM on Monday\n            'schedule': '0 3 * * 1' \n        },\n    ]\n}\n```\n\nSchedules can be specified as timedeltas for running tasks on specified intervals, or as cron-syntax strings for running tasks on exact schedules.\n\n\n**routing.py**\n\n```python\napplication = ProtocolTypeRouter({\n    \"channel\": ChannelNameRouter({\n        \"testing-print\": PrintConsumer,\n    }),\n})\n```\n\n**consumers.py**\n\n```python\nfrom channels.consumer import SyncConsumer\n\nclass PrintConsumer(SyncConsumer):\n    def test_print(self, message):\n        print(message)\n```\n\n### How to run:\n\n```shell\npython manage.py beatserver\n```\n","funding_links":[],"categories":["Third-Party Packages"],"sub_categories":["Task Queues"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajasimon%2Fbeatserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frajasimon%2Fbeatserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajasimon%2Fbeatserver/lists"}