Sample usage¶

Simply usage¶

from errbot import BotPlugin
from errcron.bot import CrontabMixin


class Crontab(BotPlugin, CrontabMixin):
    CRONTAB = [
        '0 8 * * * .post_morning_call'
    ]

    def activate(self):
        super().activate()
        self.activate_crontab()

    def morning_meeting(self, polled_time):
        user =  self.build_identifier('#general')
        return self.send(user, 'Just {} o-clock!!'.format(polled_time.strftime('%H')))

Using crontab bot plugin must be extended by CrontabMixin. And call activate_crontab in activation plugin.
Define schedule and job as like as crontab in CRONTAB property in bot-plugin class.
Cronjob function has least one arguments. polled_time is datetime instance of time called in function.

Crontab scheduling¶

errcron use crontab like job scheduliing. See crontab page in PyPI

Set timezone¶

If scheduling timezone is not same machine timezone, you can change timezone settings in plugin.

To use, set timezone string for TIMEZONE property in plugin class.

class Crontab(BotPlugin, CrontabMixin):
    TIMEZONE = 'America/New_York'

You can set timezone config.py instead of plugin class.