Metadata-Version: 1.1
Name: pidlock
Version: 1.1.3
Summary: Simple PID based locking for cronjobs, UNIX scripts or python programs
Home-page: https://github.com/sayanarijit/pidlock
Author: Arijit Basu
Author-email: sayanarijit@gmail.com
License: MIT
Download-URL: https://github.com/sayanarijit/pidlock/archive/v1.1.3.tar.gz
Description-Content-Type: text/markdown
Description: [![PyPI version](https://img.shields.io/pypi/v/pidlock.svg)](https://pypi.python.org/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
        ```
        
Keywords: PID Based File Locking
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
