beat

Start the beat periodic task scheduler.

def beat(
    ctx: click.Context,
    detach: boolean = False,
    logfile: string = null,
    pidfile: string = null,
    uid: string = null,
    gid: string = null,
    umask: string = null,
    workdir: string = null,
    kwargs: dict
) - > null

Start the beat periodic task scheduler.

Parameters

Name	Type	Description
ctx	click.Context	The Click context object containing the Celery application instance and configuration.
detach	boolean = False	Whether to daemonize the process and run the scheduler in the background.
logfile	string = null	The file path where scheduler logs should be written.
pidfile	string = null	The file path used to store the process ID for daemon management.
uid	string = null	The user ID or username to switch to when dropping privileges.
gid	string = null	The group ID or group name to switch to when dropping privileges.
umask	string = null	The file mode creation mask to use when running as a daemon.
workdir	string = null	The working directory to change to after detaching.
kwargs	dict	Additional configuration options including schedule file path, scheduler class, and log level.

Returns

Type	Description
null	This method runs the scheduler loop and does not return a value until the process is terminated.