Cron Schedule Triggers ~ A library for determining Quartz Cron schedule trigger dates.
Project description
CronScheduleTriggers: Quartz Syntax based Cron Trigger library.
Cron Schedule Triggers (CSTriggers) is a Python library enabling the ability to determine the next execution of a live schedule. Its syntax is that of Quartz Job Scheduler. This library is not a scheduling app or a task queue, there are plenty of those in the wild to choose from. When you need advanced customisation of triggers for tasks, and a common and conventional syntax for schedule notation, CSTriggers comes to your aid.
This library is for those who
- Want the ability to generate future task data for visualization purposes.
- Want to combine their own choice of solutions to build a customizable integrated task queuing/scheduling system at any scale.
- Do not want to run java, but want to take advantage of the rich Quartz Cron syntax
- Do not want to drag in many dependencies into their project (Uses standard Python3 libraries only).
Example usage
Initialize a schedule object with a cron notation string, a start date, and an optional end date. Call .next_trigger()
for a new date. Notice that when an end_date is given, The schedule terminates at 2022-10-13T00:00:00
and not 2030-03-01T00:00:00
as it would naturally.
from cstriggers.core.trigger import QuartzCron
schedule_string = "0 0 0 1 JAN-MAR ? 2010-2030"
start_date = "2019-10-13T00:00:00"
end_date = "2022-10-13T00:00:00"
cron_obj = QuartzCron(schedule_string=schedule_string, start_date=start_date, end_date=end_date)
print(cron_obj.next_trigger(isoformat=True))
>> 2020-01-01T00:00:00
For multiple sequential dates call either .next_trigger()
multiple times.
from cstriggers.core.trigger import QuartzCron
schedule_string = "0 0 0 1 JAN-MAR ? 2010-2030"
start_date = "2019-10-13T00:00:00"
end_date = "2022-10-13T00:00:00"
cron_obj = QuartzCron(schedule_string=schedule_string, start_date=start_date, end_date=end_date)
print(cron_obj.next_trigger(isoformat=True))
print(cron_obj.next_trigger(isoformat=True))
>> 2020-01-01T00:00:00
>> 2020-02-01T00:00:00
Or call .next_triggers()
with the number of triggers needed.
from cstriggers.core.trigger import QuartzCron
schedule_string = "0 0 0 1 JAN-MAR ? 2010-2030"
start_date = "2019-10-13T00:00:00"
end_date = "2022-10-13T00:00:00"
cron_obj = QuartzCron(schedule_string=schedule_string, start_date=start_date, end_date=end_date)
print(cron_obj.next_triggers(number_of_triggers=10, isoformat=True))
>> [
'2020-01-01T00:00:00',
'2020-02-01T00:00:00',
'2020-03-01T00:00:00',
'2021-01-01T00:00:00',
'2021-02-01T00:00:00',
'2021-03-01T00:00:00',
'2022-01-01T00:00:00',
'2022-02-01T00:00:00',
'2022-03-01T00:00:00',
'2023-01-01T00:00:00'
]
Roadmap
- Support for last_trigger(s) to retroactively look at schedule dates.
- Support for AWS Cron Expression syntax.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cron-schedule-triggers-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee7702fd1d1660aa28452498914098f6790f93740490dd615dfdeeb4107fc62e |
|
MD5 | b79383b8084fe6abcf064d37946bb7d0 |
|
BLAKE2b-256 | fdf10040695a44c0c43f4f04b94fac14621a354524688df8e0618dfe50cac07d |
Hashes for cron_schedule_triggers-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43e11793e192d89423d2de14d2cd4117e60cddc27b60a8e69c1f57707fab500e |
|
MD5 | 7fa675727a7eafc53bc9dcef671530bf |
|
BLAKE2b-256 | fc7a7e2335cb6b2d047c741a2667a5374141fd40b64af563930f1f2f24324fba |