https://github.com/heavenshell/py-robo-cron

Mount cron system to robo.
https://github.com/heavenshell/py-robo-cron

Last synced: 2 months ago
JSON representation

Mount cron system to robo.

• Host: GitHub
• URL: https://github.com/heavenshell/py-robo-cron
• Owner: heavenshell
• License: bsd-3-clause
• Created: 2015-01-19T15:02:05.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-06-14T10:22:57.000Z (about 10 years ago)
• Last Synced: 2025-03-06T02:12:11.338Z (over 1 year ago)
• Language: Python
• Size: 24.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
robo.handlers.cron

==================

.. image:: https://travis-ci.org/heavenshell/py-robo-cron.svg?branch=master

    :target: https://travis-ci.org/heavenshell/py-robo-cron

Mount cron system to `robo `_.

Send messages on a specific time.

Install

-------

.. code::

  $ pip install git+https://github.com/heavenshell/py-robo-cron

Dependency

----------

This handler depends on `APScheduler `_.

If you want to persistent job, you can use `Redis `_.

Usage

-----

Add job to run `robo` handler.

.. code::

  > robo add job "*/1 * * * *" robo echo hello

  Job Scheduler.message (trigger: cron[month='*', day='*', day_of_week='*', hour='*', minute='*/1'], next run at: 2015-01-23 00:53:00 JST) created.

  hello

List all jobs.

.. code::

  > robo list jobs

  61530a5a8e7e40c7814ce90768792476: "*/1 * * * *" 2015/01/23 00:55:00 robo echo hello

Pause specific job.

.. code::

  > robo pause job 61530a5a8e7e40c7814ce90768792476

  Job paused.

Resume paused job.

.. code::

  > robo resume job 61530a5a8e7e40c7814ce90768792476

  Job resumed.

Delete job.

.. code::

  > robo delete job 61530a5a8e7e40c7814ce90768792476

  Success to delete job.

Show cron expression.

.. code::

  > robo job expression

        * * * * *

        T T T T T

        | | | | `- day_of_week - 0 ..  6

        | | | `--- month ------- 1 .. 12

        | | `----- day --------- 1 .. 31

        | `------- hour -------- 0 .. 23

        `--------- minute ------ 0 .. 59

Job persistence

~~~~~~~~~~~~~~~

Add `jobstore` options to Robot options.

.. code:: python

  def main(args=None):

      logging.basicConfig(level=args.verbose, format=Robot.debug_log_format)

      logger = logging.getLogger('robo')

      options = {

          'cron': {'jobstore': 'redis', 'options': {'alias': args.name}}

      }

      robot = Robot(name=args.name, logger=logger, **options)

      robot.register_default_handlers()

      robot.load_adapter(args.adapter)

      robot.run(args.adapter)