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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63bce533ae20599179f3a5f29c27aa1884740dfbf9e5144bf0e2e5f73892a6cb |
|
MD5 | db73c8773c04f0edb1fd4ce340637b8e |
|
BLAKE2b-256 | 8b18a17e97d1155166f61ac88861302a069bb05e240ca64a3b351391f98129a2 |
Hashes for cron_schedule_triggers-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3706a69a78956809797e6c11f0b0354e0429ccc2a29a40027518a4a5441a5802 |
|
MD5 | 64c9558928296840ec0cf688e075c81c |
|
BLAKE2b-256 | 0d44d1b243c1f5b5f950c2b28b85614f92652614486215855881e07e12dc784f |