Skip to content

Commit

Permalink
update readme to add scheduling section
Browse files Browse the repository at this point in the history
  • Loading branch information
kerrychu committed Jan 17, 2024
1 parent c142064 commit bfddec2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Bunya Jobs

**⚠️This repo is still under active development.**
**⚠️This repo is still under ACTIVE development.**

![under construction](construction.png)
## Scheduling

- For the moment, you can fork it and use crontab to run `monitor.py`
- For the moment, you can fork it, or just clone it and use crontab to run `monitor.py`
- Follow the `dot_env_template` to create your own `.env` file
- then do `crontab -e`
- and add `* * * * * your-python-path complete-file-path-to-monitor.py` to your cronjob
- for example, `* * * * * ~/anaconda3/bin/python /scratch/user/your-username/bunya_jobs/monitor.py`
- then your jobs will be monitored at an 1 minute interval
- if you wish to have a different interval, check this [page](https://www.atatus.com/tools/cron).

## Slack Integration

- follow [slack webhook tutorial](https://api.slack.com/messaging/webhooks) to create a slack app for your slack workspace and add it to appropriate channels
- remember to replace the `.env` webhook to your own
Binary file removed construction.png
Binary file not shown.

0 comments on commit bfddec2

Please sign in to comment.