rainydais-cron

A lightweight Python library to simplify cron job management.


Keywords
cron, job, RainyDais, kgsensei, cronjob-scheduler, cronjobs, library, python3
License
MIT
Install
pip install rainydais-cron==1.2

Documentation

Cron Library

------ A libary by RainyDais ------

divider

How it works

The cron Library provides a simple and efficient way to automate tasks based on specified time intervals.

How to use

divider
  • Import the module to use the cron library

This can be done by using:

import cron
divider
  • Define a function

This can be done using:

def your_function():
    print("your_text")

The def your_function(): is what you use to make a function, this function will say your_text.

Example:

def Hello_Function():
    print("Hello World")
divider
  • Define a function that will tell you when it runs, this will be told every x seconds

This can be done using:

def time_alert_function(seconds):
    print("I run every {0} seconds!".format(seconds))
divider
  • Create a function to run every x amount of times

Make a first example function to run every 5 seconds

cron.addJob(example_function, 5)

Create a second example function to run every 1 second

cron.addJob(time_alert_function, 1, 1)

Currently the addJob parameters are; function, timeout/cron delay, args (only 1 supported currently)

divider
  • How to call your Cron jobs

You can use this function:

cron.start()

Option: pass True into the function call to make it non-thread blocking

Example:

cron.start(True)

Default is False or thread blocking.

This will start your timer fyunction, that will then execute your cron jobs.

divider
  • To prevent your program from ending whilst using non-thread blocking mode

You can use:

input("\n   Hello, this is the end of the file!\n\n")

This will also act as a test to prove cron.start() isn't blocking the thread It contains newline characters so it doesn't get put on the same line as other print messages that will come in from the threaded cron jobs.