Package: skedulord
Skedulord is a tool that automates scheduling and logging of jobs. It's a
layer on top of cron. It's mainly meant for Python users but it can also be
used for other tools launched from the command line.If you're new, check out thegetting started guide.InstallationpipinstallskedulordIf you like to live dangerously, you can also install from GitHub for the latest commit.python -m pip install --upgrade "skedulord @ git+https://github.com/koaning/skedulord.git"UsageThese are all the commands available:> python -m skedulord
Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

  SKEDULORD: helps with cronjobs and logs.

Options:
  --help  Show this message and exit.

Commands:
  schedule  Set (or reset) cron jobs based on config.
  run       Run a single command, which is logged by skedulord.
  history   Shows a table with job status.
  summary   Shows a summary of all jobs.
  build     Builds static html files so you may view a dashboard.
  serve     Opens the dashboard in a browser.
  wipe      Wipe the disk or schedule state.
  version   Show the version.DocmentationThe docs are hosted on GitHub Pages and can be foundhere.DemoLet's say we've got this small python file.# script.pyforiinrange(5):print(f"i am at iteration{i}")The idea here is thatskedulordcan run this and keep track of logs.python -m skedulord run jobname1 "python script.py" --retry 3 --wait 60
python -m skedulord run jobname2 "python script.py" --retry 3 --wait 60This will run the"python script.py"command as if you'd normally run it
from the command line. Theskedulordparts around it do some extra things though.LogsThe main thingskedulorddoes is structure logs from your scripts. The logs
are generated in a structured format so it's easy to find bugs. When we ran
theskedulord runcommand we attached a jobname (aptly named"jobname") which
will also be the name of the folder where logs can be found.> tree ~/.skedulord/
/Users/vincent/.skedulord/
├── heartbeat.jsonl
├── jobname1
│   ├── 2021-02-14T16:56:34.html
│   └── 2021-02-14T16:56:34.txt
└── jobname2
    ├── 2021-02-14T16:56:35.html
    └── 2021-02-14T16:56:35.txtThe logs themselves have a timestamp as the filename. There are basic.txtlogs
but also fancy.htmllogs which render nicely in a dashboard.MechanicsWe've designedskedulordto also be able to rerun jobs if they fail. Hiccups are
part of real life and sometimes we can make a job succeed by trying again 5 minutes
later. This is why you can specify how many attempts you'd like the job to make by
setting--retry. You can also specify the wait time between attempts via--wait.ScheduleThe nice thing aboutskedulordrunning from the command line is that you can schedule
it viacrontabtoo! The downside is that it can get complex. You'd need to ensure that
the jobs have access to the correct virtual environments and this can become a drag.To help out,skedulordcan also configure cron for you by configuring a.ymlfile.# schedule.ymluser:vincentschedule:-name:pingcommand:python /home/vincent/path/scripts/ping.pycron:"*/2****"-name:github issues downloadercommand:python /full/path/to/cli.py --repo foobar --output /Users/vincent/datacron:"01***"-name:github actions downloadercommand:python /full/path/to/scrape.py --repo foobar --output /Users/vincent/datacron:"01***"Given a schedule like this, skedulord can schedule everything via;python -m skedulord schedule schedule.ymlYou can confirm yourself that all jobs are now scheduled to run, with skedulord
taking care of all the logging.crontab -eNote that when a command starts withpythonskedulord will assume the same virtualenv
as the one that ran theskedulord schedulecommand. You may also pass another Python path
if you prefer to use another virtualenv.DashboardIf you want, you can even use skedulord to run a small dashboard for you to show
all the logs from past jobs. These are all available from the terminal as well,
but it's nice to have an extra interface.python-mskedulordserveThe landing page shows an overview of all jobs.You can click on the associated link to find all runs.From here you can explore the logs. We host both the raw .txt logs
and a "fancy" variant that attemps some syntax highlighting.If you'd like to play around, we host a small demo of this dashboardhere.