Quick Start

To get started with the basic functions and Job types of the scheduler module, create a Scheduler instance and the function foo to schedule:

>>> import datetime as dt

>>> from scheduler import Scheduler
>>> import scheduler.trigger as trigger

>>> def foo():
...     print("foo")
...

>>> schedule = Scheduler()

Schedule a job that runs every 10 minutes:

>>> schedule.cyclic(dt.timedelta(minutes=10), foo)  
scheduler.Job(...CYCLIC...datetime.timedelta(seconds=600)...foo...0, 1...)

Schedule a job that runs every minute at XX:XX:15:

>>> schedule.minutely(dt.time(second=15), foo)  
scheduler.Job(...MINUTELY...datetime.time(0, 0, 15)...foo...0, 1...)

Schedule a job that runs every hour at XX:30:15:

>>> schedule.hourly(dt.time(minute=30, second=15), foo)  
scheduler.Job(...HOURLY...datetime.time(0, 30, 15)...foo...0, 1...)

Schedule a job that runs every day at 16:30:00:

>>> schedule.daily(dt.time(hour=16, minute=30), foo)  
scheduler.Job(...DAILY...datetime.time(16, 30)...foo...0, 1...)

Schedule a job that runs every monday at 00:00:

>>> schedule.weekly(trigger.Monday(), foo)  
scheduler.Job(...WEEKLY...Monday...foo...0, 1...)

Schedule a job that runs every monday at 16:30:00:

>>> schedule.weekly(trigger.Monday(dt.time(hour=16, minute=30)), foo)  
scheduler.Job(...WEEKLY...[Monday(time=datetime.time(16, 30))]...foo...0, 1...)

Schedule a job that runs exactly once in 10 minutes

>>> schedule.once(dt.timedelta(minutes=10), foo)  
scheduler.Job(...CYCLIC...datetime.timedelta(seconds=600)...foo...1, 1...)

Schedule a job that runs exactly once next monday at 00:00:

>>> schedule.once(trigger.Monday(), foo)  
scheduler.Job(...WEEKLY...[Monday(time=datetime.time(0, 0))]...foo...1, 1...)

Schedule a job that runs exactly once at the given date at 2022-02-15 00:45:00:

>>> schedule.once(
...     dt.datetime(year=2022, month=2, day=15, minute=45), foo
... )  
scheduler.Job(...CYCLIC...foo...1, 1...datetime(2022, 2, 15, 0, 45)...)

A human readable overview of the scheduled jobs can be created with a simple print statement:

>>> print(schedule)  
max_exec=inf, tzinfo=None, priority_function=linear_priority_function, #jobs=9

type     function / alias due at                 due in      attempts weight
-------- ---------------- ------------------- --------- ------------- ------
MINUTELY foo(..)          2021-06-18 00:37:15   0:00:14         0/inf      1
CYCLIC   foo()            2021-06-18 00:46:58   0:09:58         0/inf      1
ONCE     foo()            2021-06-18 00:46:59   0:09:58           0/1      1
HOURLY   foo()            2021-06-18 01:30:15   0:53:14         0/inf      1
DAILY    foo(..)          2021-06-18 16:30:00  15:52:59         0/inf      1
WEEKLY   foo()            2021-06-21 00:00:00    2 days         0/inf      1
ONCE     foo(..)          2021-06-21 00:00:00    2 days           0/1      1
WEEKLY   foo(..)          2021-06-21 16:30:00    3 days         0/inf      1
ONCE     foo()            2022-02-15 00:45:00  242 days           0/1      1

Unless Scheduler was given a limit on the execution count via the max_exec option, a call to the Scheduler instances exec_jobs() function will execute every overdue job exactly once.

For cyclic execution of Jobs, the exec_jobs() function should be embedded in a loop of the host program:

>>> import time

>>> while True:  
...     schedule.exec_jobs()
...     time.sleep(1)
...