https://github.com/atsuyaide/taskick
Taskick is an event-driven Python library that automatically executes scripts or any commands.
https://github.com/atsuyaide/taskick
event-driven python subprocess yaml
Last synced: 5 months ago
JSON representation
Taskick is an event-driven Python library that automatically executes scripts or any commands.
- Host: GitHub
- URL: https://github.com/atsuyaide/taskick
- Owner: atsuyaide
- License: mit
- Created: 2022-03-13T16:36:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-27T15:23:53.000Z (about 4 years ago)
- Last Synced: 2025-09-22T03:44:23.744Z (9 months ago)
- Topics: event-driven, python, subprocess, yaml
- Language: Python
- Homepage:
- Size: 1.61 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-ja.md
- License: LICENSE
Awesome Lists containing this project
README
# Taskick
[](https://pypi.org/project/taskick/)
Taskick は, スクリプトやコマンドを自動的に実行するイベント駆動型のPythonライブラリです.
面倒な定型作業や操作を自動化するだけでなく, [アプリケーション](https://github.com/atsuyaide/taskick#toy-example)の開発も容易にします.
[English ver. README](https://github.com/atsuyaide/taskick)
Taskickの主な機能は以下の通りです.
- コマンドやスクリプトを自動実行できます.
- スクリプトの実行タイミングや振る舞いを設定ファイル（YAML）で管理できます.
- タスクのトリガーとして, 日付やディレクトリ・ファイル操作などを指定できます.
また,
- 実行スケジュールはCrontabフォーマットで指定可能です.
- ディレクトリやファイルの操作の検出には[Watchdog](https://github.com/gorakhargosh/watchdog)を使用します. Watchdogが提供する任意の[イベントAPI](https://python-watchdog.readthedocs.io/en/stable/api.html#module-watchdog.events)は設定ファイルから指定することができます.
## インストール
```shell
$ pip install taskick
$ python -m taskick
Taskick 0.1.6
usage: python -m taskick [-h] [--verbose] [--version] [--batch-load BATCH_LOAD]
[--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
--batch-load BATCH_LOAD, -b BATCH_LOAD
configuration files can be load in batches
--file FILE [FILE ...], -f FILE [FILE ...]
specify configuration files (YAML) for the task to be executed
--log-config LOG_CONFIG, -l LOG_CONFIG
specify a logging configuration file
$ python -m taskick -V
Taskick 0.1.6
```
## Toy Example
PNG画像をPDFに変換するtoy-exampleを紹介します.
このサンプルでは, PNG画像が特定のフォルダに保存されたことを検知すると, 変換スクリプトを自動的に起動します.
スクリプトはPNG画像をPDFに変換し, 出力先のフォルダに保存します.
まず[taskick-example](https://github.com/atsuyaide/taskick-example)のコードをクローンします.
```shell
git clone https://github.com/atsuyaide/taskick-example.git
```
続いて, 以下のコマンドを実行します.
```shell
$ cd taskick-example
$ pip install -r requirements.txt
$ python -m taskick -b batch.yaml -vv
INFO:taskick:Loading: ./config/welcome.yaml
INFO:taskick:Processing: Welcome_taskick
INFO:taskick:Startup option is selected.
INFO:taskick:Registered
INFO:taskick:Loading: ./config/main.yaml
INFO:taskick:Processing: remove_files_in_input_folder
INFO:taskick:Startup option is selected.
INFO:taskick:Await option is selected.
INFO:taskick:Registered
INFO:taskick:Processing: png2pdf
INFO:taskick:Registered
INFO:taskick:Executing: Welcome_taskick
INFO:taskick:"remove_files_in_input_folder" is waiting for "Welcome_taskick" to finish.
Sun Apr 24 23:25:43 JST 2022 Welcome to Taskick!
waiting 5 seconds...
INFO:taskick:Executing: remove_files_in_input_folder
```
これでPNG画像をPDFに変換するアプリケーションを起動できました.
`input`フォルダにPNG画像を保存すると`output`フォルダに変換後のPDFファイルが出力されます.
また`input`フォルダー内のファイルは, 起動時または1分ごとに自動的に削除されます.
このアプリケーションは`welcome.yaml`と`main.yaml`で構成され, Taskickは`batch.yaml`を読み込むことで間接的に2つのファイルを読み込んでいます.
設定ファイルの詳細は, [プロジェクトページ](https://github.com/atsuyaide/taskick-example)をご覧ください.