https://github.com/Datahenge/btu

Background Tasks Unleashed: A Frappe Framework application for Task Scheduling and Automation.
https://github.com/Datahenge/btu

cron erpnext frappe-framework redis-queue task-scheduler

Last synced: 4 months ago
JSON representation

Background Tasks Unleashed: A Frappe Framework application for Task Scheduling and Automation.

• Host: GitHub
• URL: https://github.com/Datahenge/btu
• Owner: Datahenge
• License: mit
• Created: 2021-08-30T16:50:30.000Z (over 3 years ago)
• Default Branch: version-14
• Last Pushed: 2024-08-19T21:41:34.000Z (4 months ago)
• Last Synced: 2024-08-20T01:32:14.150Z (4 months ago)
• Topics: cron, erpnext, frappe-framework, redis-queue, task-scheduler
• Language: Python
• Homepage:
• Size: 584 KB
• Stars: 45
• Watchers: 5
• Forks: 19
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-frappe - Background Tasks Unleashed - A Frappe Task Scheduling and Automation. (Uncategorized / Uncategorized)

README

        
## Background Tasks Unleashed (BTU) v14

For details, please refer to the **[Official Documentation](https://datahenge.github.io/btu/)**.

* The companion application, the **BTU Scheduler**, is maintained on a separate GitHub site.

### What is BTU?

Background Tasks Unleashed is:

1. a [Frappe Framework](https://github.com/frappe) application for Task Scheduling and Automation.

2. a tool for running tasks or processes *automatically*, on a repeating schedule, in the background of your Frappe web application.

3. a robust alternative to the out-of-the-box **`Scheduled Job Types`** featured in the Frappe framework.



### Capabilities

Using only your web browser, take full control of the BTU application.  No need to SSH and modify `hooks.py`.

* **Tasks** organize your reusable jobs, enabling you to run any Python function (standard or custom) and pass your own arguments.

* **Schedules** will run Tasks in the background, at any cadence required (FYI, we can do cron...*with timezones!*)

* **Logs** give you visibility into your Task history.  Not just success or fail, but the *complete standard output and errors*.

You can also:

* Run any Task on-demand.

* When a scheduled Task completes, automatically receive an email notification (including CC and BCC)

* Use an included CLI application to interact with the BTU from a shell terminal, instead of your web browser.

----

### Installation

A complete [Installation Guide](https://datahenge.github.io/btu/installation.html) is available on BTU's GitHub Pages site.

### Copyright and License

* Background Tasks Unleashed (BTU) is licensed MIT. (*See LICENSE.md file*)

* Copyright 2021-2023, Datahenge LLC

* Maintainer: Brian Pond