Skip to main content

Shell-based job runner with logging

Project description

Job runner with logging

Build Status PyPI Release

Installation

Install system-wide:

$ pip install shell-jobrunner

Install just for the current user:

$ pip install --user shell-jobrunner

Uninstallation

$ pip uninstall jobrunner

Examples

  • Run sleep 5 in the background

    $ job sleep 5
  • Run ls when the last job finishes and it passed (exit code 0)

    $ job -B. ls
  • Run ls when last job finishes (pass / fail)

    $ job -b. ls
  • Monitor job execution

    $ job -W
    Sat Aug 10, 2019 20:48:23  No jobs running, load: 0/0/0
  • Retry a job

    $ job --retry ls

Query Examples

NOTE . is available as an alias to the most recently executed job (as in the Examples above).

  • View recently executed job log file

    $ job ls
    $ view `job`   # Opens the output from ls using "view"
  • View two most recently executed

    $ job echo 1
    $ job echo 2
    $ view `job -n0 -n1`
  • Query by job name

    $ job echo foo
    $ job echo bar
    $ view `job -g foo`
  • Show job info by name

    $ job ls
    $ job -s ls

Configuration

The default configuration file location is ~/.config/jobrc, but can be
overridden using the –rc-file option.

Sample rcfile:

[mail]
program = mail
# For notifications over chat applications (like Google Chat), use chatmail as
# your mail program instead. "chatmail" must be specified rather than a differently
# named link to the script, else some options provided to job (such as --rc-file)
# will not be passed through to it.
# program = chatmail
domain = example.com
[ui]
watch reminder = full|summary  # default=summary
[chatmail]
at all = all|none|no id # default=none
reuse threads = true|false # default true
[chatmail.google-chat-userhooks]
user1 = https://chat.googleapis.com/v1/spaces/...
[chatmail.google-chat-userids]
# Retrieve this using your browser inspector on an existing mention of this user.
# It should show up as "user/some_long_integer" somewhere in the span's metadata.
user1 = <long integer>

System Notifications (Systemd user service example)

If you want to enable notifications when jobs finish, one way to do this is to use the –notifier argument.

~/.config/systemd/user/job-notify.service:

[Unit]
Description=Jobrunner Notifier

[Service]
Type=simple
ExecStart=env job --notifier jsonNotify.py
RestartSec=30
Restart=always

[Install]
WantedBy=default.target

~/.local/bin/jsonNotify.py:

#!/usr/bin/env python3

from json import load
import subprocess
from sys import stdin

cmd = ["notify-send"]
data = load(stdin)
rc = data.get("rc", 0)
if rc != 0:
    cmd += ["--urgency=critical"]
cmd += [data["subject"], data["body"]]
subprocess.run(cmd)

Hacking

Primary workflow

It’s highly recommend to work inside a virtualenv using pipenv.

Create new virtualenv and install an editable version of jobrunner:

pipenv --three install --dev
pipenv run pip install -e .

Autoformat the code and check linters:

pipenv run ./format.sh

Run tests:

pipenv run pytest

Run CI checks locally

This allows you to run something similar to the azure pipelines locally using docker.
It will use PIP_INDEX_URL and / or ~/.config/pip/pip.conf to configure a pypi mirror.
This will also update Pipfile*.lock.
./test-docker.py [--versions 2.7 3.7 3.8] [--upgrade] [--ignore-unclean]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shell_jobrunner-2.7.1.tar.gz (85.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shell_jobrunner-2.7.1-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

Details for the file shell_jobrunner-2.7.1.tar.gz.

File metadata

  • Download URL: shell_jobrunner-2.7.1.tar.gz
  • Upload date:
  • Size: 85.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for shell_jobrunner-2.7.1.tar.gz
Algorithm Hash digest
SHA256 4cbdcd77873f5473ac849f63b18dcc73e66447c06e38e9e29e106ab9a259766b
MD5 d147b2d5b8442b7c88d4c8bed9f2b4f2
BLAKE2b-256 b47f9c1033b661b2995d38bfb6ee8d470e60c439b9f7f14c09eea5ccd50896b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_jobrunner-2.7.1.tar.gz:

Publisher: python-publish.yml on wwade/jobrunner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shell_jobrunner-2.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for shell_jobrunner-2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9c2806cd081a44773ed50d6a538243c7ed0c549918094038bc7189389e677d4e
MD5 266c9b041a6edb5d70cd5e69787fd6e0
BLAKE2b-256 f11eb01b45706ca3bb6fbfb7ae51d4af474607023f81f9c32daeed4f14fa5fa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_jobrunner-2.7.1-py3-none-any.whl:

Publisher: python-publish.yml on wwade/jobrunner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page