taskick 0.1.5a4

No project description provided

Taskick

Taskick is an event-driven Python library that automatically executes scripts or any commands. It not only automates tedious routine tasks and operations, but also makes it easy to develop applications.

Users can concentrate on developing scripts to run, and simply create a configuration file (YAML) to automatically execute scripts triggered by any date, time, or event.

The main features of Taskick are as follows

• Script execution timing can be managed in a configuration file (YAML).
• Can specify datetime and directory/file operations as task triggers.
• Execution schedules can be specified in Crontab format.
• Watchdog is used to detect directory and file operations. It is also possible to specify any events API on the configuration file.

Installation

$ pip install taskick
$ python -m taskick
Taskick 0.1.5a4
usage: __main__.py [-h] [--verbose] [--version] [--file FILE [FILE ...]]
                   [--log_config LOG_CONFIG]

optional arguments:
  -h, --help            show this help message and exit
  --verbose, -v         increase the verbosity of messages: '-v' for normal
                        output, '-vv' for more verbose output and '-vvv' for
                        debug
  --version, -V         display this application version and exit
  --file FILE [FILE ...], -f FILE [FILE ...]
                        select task configuration files (YAML)
  --log_config LOG_CONFIG, -l LOG_CONFIG
                        select a logging configuration file (YAML or other)
$ python -m taskick -V
Taskick 0.1.5a4

Toy Example

Here is a toy-eample that converts a PNG image to PDF. In this sample, Taskick starts a script when it detects that a PNG image has been saved to a specific folder. The script converts the PNG to PDF and saves it in another folder. For more information, please see the project page.

First, clone taskick-example.

git clone https://github.com/atsuyaide/taskick-example.git

Go to the cloned directory and start Taskick.

$ cd taskick-example
$ pip install -r requirements.txt
$ python -m taskick -f welcome.yaml main.yaml -vv
INFO:taskick:Loading: welcome.yaml
INFO:taskick:Processing: Welcome_taskick
INFO:taskick:Startup execution option is selected.
INFO:taskick:Registered: Welcome_taskick
INFO:taskick:Loading: main.yaml
INFO:taskick:Processing: remove_files_in_input_folder
INFO:taskick:Startup execution option is selected.
INFO:taskick:Registered: remove_files_in_input_folder
INFO:taskick:Processing: png2pdf
INFO:taskick:Registered: png2pdf
INFO:taskick:Executing: Welcome_taskick
INFO:taskick:"remove_files_in_input_folder" is waiting for "Welcome_taskick" to finish.
Sun Mar 27 00:10:45 JST 2022 Welcome to Taskick!
waiting 5 seconds...
INFO:taskick:Executing: remove_files_in_input_folder

When a PNG image is saved in the input folder, a converted PDF file is output in the output folder. Files in the input folder are automatically deleted at startup or every minute.

These tasks are controlled by main.yaml and managed by Taskick. These tasks are controlled by Taskick, and the behavior of the tasks is controlled by main.yaml and welcome.yaml.