https://github.com/metwork-framework/cron-wrapper

A cron job wrapper to add some missing features (locks, timeouts, random sleeps, env loading...)
https://github.com/metwork-framework/cron-wrapper

autoreadme github-actions incubation integration-level-3

Last synced: about 1 month ago
JSON representation

A cron job wrapper to add some missing features (locks, timeouts, random sleeps, env loading...)

• Host: GitHub
• URL: https://github.com/metwork-framework/cron-wrapper
• Owner: metwork-framework
• License: mit
• Created: 2015-04-27T10:28:11.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-20T15:22:43.000Z (3 months ago)
• Last Synced: 2024-10-21T15:39:50.362Z (2 months ago)
• Topics: autoreadme, github-actions, incubation, integration-level-3
• Language: Python
• Homepage:
• Size: 81.1 KB
• Stars: 9
• Watchers: 6
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# cron-wrapper

[//]: # (automatically generated from https://github.com/metwork-framework/github_organization_management/blob/master/common_files/README.md)

**Status (master branch)**

[![GitHub CI](https://github.com/metwork-framework/cron-wrapper/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/metwork-framework/cron-wrapper/actions?query=workflow%3ACI+branch%3Amaster)

[![Maintenance](https://raw.githubusercontent.com/metwork-framework/resources/master/badges/maintained.svg)](https://github.com/metwork-framework/resources/blob/master/badges/maintained.svg)

## What is it ?

A cron job wrapper to add some missing features (locks, timeouts, random sleeps, env loading...).

## Setup

```shell

pip install cron-wrapper

```

## Usage

```

Usage: cronwrap [options]

Options:

  -h, --help            show this help message and exit

  -t TIMEOUT, --timeout=TIMEOUT

                        command timeout (in seconds); 0 means no timeout;

                        default: 3600

  -r RVALUE, --random-sleep=RVALUE

                        wait a random value of seconds between 0 and RVALUE

                        before executing command (default 0: no random wait)

  -l, --lock            don't execute the command another time if still

                        running (default False)

  -e, --load-env        load environnement file before executing command

                        (default: False)

  -f LOAD_ENV_FILE, --load-env-file=LOAD_ENV_FILE

                        set the environnement file to load if load-env option

                        is set (default: ~/.bashrc)

  -s SHELL, --shell=SHELL

                        full path of the shell to use (default /bin/sh)

  -n NICE, --nice=NICE  'nice' value (from -20 (most favorable scheduling) to

                        19 (least favorable))

  -i IONICE, --ionice=IONICE

                        'ionice' class (1 for realtime, 2 for best-effort, 3

                        for idle)

  --low                 short cut for '-i 3 -n 19' (minimum priority)

```

## Real-life usage example

In a user `crontab`:

```

*/10 * * * * cronwrap --load-env --lock --low -- slow_cleaning_command.sh slow_cleaning_command_option

```

to run `slow_cleaning_command.sh slow_cleaning_command_option` every 10 minutes but with:

- the user environement loaded before execution

- with a (default) execution timeout of 3600 seconds

- minimal system priority

- with a lock to avoid several execution at the same time (if the previous run is still alive)

## Contributing guide

See [CONTRIBUTING.md](CONTRIBUTING.md) file.

## Code of Conduct

See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.

## Sponsors

*(If you are officially paid to work on MetWork Framework, please contact us to add your company logo here!)*

[![logo](https://raw.githubusercontent.com/metwork-framework/resources/master/sponsors/meteofrance-small.jpeg)](http://www.meteofrance.com)