Skip to content

A scheduler built on cron syntax with weekend/holiday features

License

Notifications You must be signed in to change notification settings

fr3h4g/scheduleplus-python

Repository files navigation

scheduleplus

A scheduler built on cron syntax with workday/holiday check feature

Atributes Allowed values Allowed special characters Required
Minutes 0-59 * , - / Yes
Hours 0-23 * , - / Yes
Days 1-31 * , - / L Yes
Months 1-12, JAN-DEC * , - / Yes
Weekdays 0-6, MON-SUN * , - / F L Yes
Holiday(* 0, 1 * No

Holiday*

0 = checking if workday, 1 = checking if holiday, * = any day

Installation

pip install scheduleplus

Usage

Running a function on schedule

This runs the function every 5 minutes.

from scheduleplus.schedule import Scheduler

def work(data):
    print(f"Working {data}...")

schedule = Scheduler()

schedule.cron("*/5 * * * *").do_function(work, "test")

while True:
    schedule.run_function_jobs()
    time.sleep(1)

Running a callback

This runs the callback with a dictonary every 5 minutes.

from scheduleplus.schedule import Scheduler

def work(data):
    print(f"Working {data}...")

schedule = Scheduler()

schedule.cron("*/5 * * * *").do_callback({"message": "cool"})

while True:
    schedule.run_callback_jobs(work)
    time.sleep(1)

List jobs

schedule = Scheduler()

schedule.cron("*/5 * * * *").do_function(work, "test")
schedule.cron("1 1 1 1 1").do_callback({"message": "cool"})

schedule.list_jobs()

Result

Job id   Cron          Next run time         Time left             Function        Callback message
-------- ------------- --------------------- --------------------- --------------- ---------------------
1        */5 * * * *   2022-11-04 13:50:00   0:00:29               work('test')
2        1 1 1 1 1     2030-01-01 01:01:00   2614 days, 11:11:29                   {'message': 'cool'}

About

A scheduler built on cron syntax with weekend/holiday features

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages