tiny-taskbot 1.0.0

A lightweight Python scheduler for timer and file-change tasks.

Tiny TaskBot

Tiny TaskBot is a lightweight Python scheduler for timer-based and file-change tasks. It can send notifications or run commands, with optional logging.

---

Features

• Timer tasks: run daily at a specified time.
• File-change tasks: monitor folders for changes.
• Actions: notifications or shell commands.
• Dry-run mode: see tasks without executing them.
• Optional logging to a file.

---

Installation

1. Clone the repository:

git clone https://gitlab.com/dmxsoftware/tiny-taskbot.git
cd tiny-taskbot

2. Create a virtual environment

python3 -m venv venv
source venv/bin/activate  # Linux/MacOS
venv\scripts\activate     # Windows

3. Install the dependencies

pip install -r requirements.txt

4. Get the example tasks.json file:

cp example_tasks.json tasks.json

Usage

1. Edit tasks.json to define your tasks.
2. Run Tiny Task-Bot:

python bot.py

3. (Optional) Dry-run mode: (What is dry-run mode?)

python bot.py --dry-run

4. Enable logging:

python bot.py --log scheduler.log

You can combine dry-run and logging if you want to.

python bot.py --dry-run --log dry_run.log

Example tasks.json

[
  {
    "name": "Morning Reminder",
    "trigger": {
      "type": "timer",
      "time": "09:00"
    },
    "action": {
      "type": "notify",
      "message": "Good morning! Time to start your day."
    }
  },
  {
    "name": "Run Backup Script",
    "trigger": {
      "type": "timer",
      "time": "23:00"
    },
    "action": {
      "type": "run_command",
      "command": "python3 backup.py"
    }
  },
  {
    "name": "Watch Documents Folder",
    "trigger": {
      "type": "file_change",
      "path": "/home/user/Documents"
    },
    "action": {
      "type": "notify",
      "message": "Documents folder has changed!"
    }
  }
]

---

Dry-run mode explained

The dry-run mode previews all tasks without executing them. Useful to validate your tasks.json and see which tasks would run.

Input:

python bot.py --dry-run

Example output:

1. Morning Reminder - Timer at 09:00 -> Notify: Good morning! Time to start your day.
2. Run Backup Script - Timer at 23:00 -> Run command: python3 backup.py
3. Watch Documents Folder - Watch folder /home/user/Documents -> Notify: Documents folder has changed!

---

Logging

You can log all scheduler output to a file using the --log option:

python bot.py --log my_log.log

or specify a specific place to put the log file:

python bot.py --log /home/user/logs/my_log.log

• Logs all timer and file-change activity.
• Preserves timestamps and action details.

[!tip] You can name the log file anything. For example: log_12-05-2025.

---

Dependencies

• Python 3.7+
• Rich - for console output
• Watchdog - for file monitoring
• Schedule - for timer tasks
• Plyer - for notifications

---

Useful tips

• Ensure timer tasks use 24-hour format (HH:MM).
• File-change tasks require a valid path. Use full paths if needed to arrive errors.

---

Support

If you find any issues or have suggestions, please open an issue on GitLab.

---

License

Tiny TaskBot is licensed under the MIT License. See the LICENSE file for details.