Skip to main content

Simple PID based locking for cronjobs, UNIX scripts or python programs

Project description

[![PyPI version](https://img.shields.io/pypi/v/pidlock.svg)](https://pypi-hypernode.com/pypi/pidlock)
[![Build Status](https://travis-ci.org/sayanarijit/pidlock.svg?branch=master)](https://travis-ci.org/sayanarijit/pidlock)


# pidlock

Simple PID based locking for cronjobs, UNIX scripts or python programs


### Requirement:

* requires python (>2 or 3)


### Usage:

* Install with pip

```bash
sudo pip install -U pidlock
```

* Use it from inside python script

```python
import time
from pidlock import PIDLock

locker = PIDLock()
with locker.lock('sleepy_script'):
time.sleep(10)
```

* Use it as commandline/cron job

```bash
# To display help menu
pidlock -h # Or pidlock --help

# Example usage
pidlock -n sleepy_script -c 'sleep 10'

# Same as
pidlock --name sleepy_script --command 'sleep 10'
```


### Customization:

* You can pass PID file location and verbosity as arguments

```python
# Python Usage
locker = PIDLock(lockdir='~/.pidlock', verbose=True)
```
```bash
# Commandline usage
pidlock -n sleepy_script -c 'sleep 10' -l ~/.pidlock -v

# Same as
pidlock --name sleepy_script --command 'sleep 10' --lockdir ~/.pidlock --verbose
```

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

pidlock-1.1.3.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file pidlock-1.1.3.tar.gz.

File metadata

  • Download URL: pidlock-1.1.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pidlock-1.1.3.tar.gz
Algorithm Hash digest
SHA256 5c4116c0702c935105790e034cf124111b4eb7a9ce3abdfe6178167fb886d384
MD5 b4d9c0f381d0cd615abd042fb06dad25
BLAKE2b-256 de89ec6d396dd2458f100136bbbdace3eb73098206252bcee7934afd2bb561a5

See more details on using hashes here.

Supported by

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