:py:mod:`EVECelery.EVECeleryBeatScheduler`
==========================================

.. py:module:: EVECelery.EVECeleryBeatScheduler


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   EVECelery.EVECeleryBeatScheduler.EVECeleryBeatScheduler




.. py:class:: EVECeleryBeatScheduler(broker_user: Optional[str] = None, broker_password: Optional[str] = None, broker_host: Optional[str] = None, broker_port: Optional[int] = None, broker_vhost: Optional[str] = None, result_user: Optional[str] = None, result_password: Optional[str] = None, result_host: Optional[str] = None, result_port: Optional[int] = None, result_db: Optional[int] = None, queue_prefix: str = 'EVECelery.', worker_log_level: Optional[str] = 'ERROR', connection_check: bool = False)

   Bases: :py:obj:`EVECelery.EVECeleryWorker.EVECeleryWorker`

   Celery beat scheduler for periodic tasks.


   .. py:method:: schedule_task(schedule_name: str, schedule_config: dict)

      Schedule a task to run at intervals. The passed in schedule object is a dictionary following the
      format and fields described here:
      https://docs.celeryproject.org/en/stable/userguide/periodic-tasks.html#available-fields

      :param schedule_name: Name of the scheduled job. This must be unique.
      :param schedule_config: The scheduled job config as specified at
          https://docs.celeryproject.org/en/stable/userguide/periodic-tasks.html#available-fields
      :return: None


   .. py:method:: start()

      Starts the Celery app and beings processing messages in the queues.

      :return: None