duck.cli.commands.service

Module containing commands for creating and managing Duck services using systemd (compatible with linux-based systems only).

Module Contents

Classes

ServiceCommand

Data

SERVICE_CONTENT

API

duck.cli.commands.service.SERVICE_CONTENT = <Multiline-String>
class duck.cli.commands.service.ServiceCommand[source]
classmethod autorun(kill: bool = False, enable: bool = False, disable: bool = False, settings: str = None, show_status: bool = True)[source]

This automatically creates and runs the Duck service at latest changes, you do not need to reload systemd, everything will be done for you.

The status of the service will be printed after if the other steps completed successfully.

Parameters:

  • kill – Whether to kill a running Duck service (if present) before running this new latest service.

  • enable – Enables the new service to be started on boot.

  • disable – Disables the new service not to be started on boot.

  • settings – Customizable comma-separated Duck settings you want to change at runtime without depending on settings.py. Example: key=value, key2=value2

  • status – Whether to show status of the service if other steps completed.

classmethod check_service()[source]

Method to check the status of the systemd service and display detailed information.

classmethod create_service(settings: str = None)[source]

Function to create the systemd service for Duck.

Parameters:

settings – Customizable comma-separated Duck settings you want to change at runtime without depending on settings.py. Example: key=value, key2=value2

Notes:

  • The settings argument can only be useful for string value type settings.

Example Usage:

duck service create --settings "systemd_exec_command=duck runserver -p 5000, systemd_restart=always"
classmethod disable_service()[source]

Method to disable the systemd service from starting on boot

classmethod enable_service()[source]

Function to enable the systemd service to start on boot

classmethod register_subcommands(main_command: click.Command)[source]

Register the subcommands for the duck service command.

classmethod reload_systemd()[source]

Method to reload systemd to apply the new service

classmethod start_service()[source]

Method to start the systemd service

classmethod stop_service()[source]

Method to stop the systemd service