Simple Lockfile System.
Project description
[![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/)
[![Build Status](https://travis-ci.org/0h-n0/simple-lock.svg?branch=master)](https://travis-ci.org/0h-n0/simple-lock)
[![codecov](https://codecov.io/gh/0h-n0/view-lockfile/branch/master/graph/badge.svg)](https://codecov.io/gh/0h-n0/view-lockfile)
[![Maintainability](https://api.codeclimate.com/v1/badges/9a8b4b39d3673ccb6db6/maintainability)](https://codeclimate.com/github/0h-n0/simple-lock/maintainability)
# simple-lock
> Note
Simple-lockfile uses a file as a lock system.
## Coencept
## How to use
The following example is based on Django project. With this module, you can lock a view method in your app.
```settings.py
from simple_lock import SimpleLock
# ~~~
File.set_root_path('/home/hoge/')
# A lockfile is created in the root_path directory without setting path as arguments.
```
```app/view.py
from response_lockfile import lock_lockfile
# ~~~
@lock_view(name='lockfile1.lock')
def view():
#some_logic
return HttpResponse()
```
This decoreator creates lockfile1.lock and releases.
```app2/view.py
from response_lockfile import watch_lockfile
# ~~~
@watch_lockfile(name='lockfile1.lock')
def view():
return HttpResponse()
```
If lockfile1.lock exists when execute app2/view:view, this decoreator returns a http response.
[![Build Status](https://travis-ci.org/0h-n0/simple-lock.svg?branch=master)](https://travis-ci.org/0h-n0/simple-lock)
[![codecov](https://codecov.io/gh/0h-n0/view-lockfile/branch/master/graph/badge.svg)](https://codecov.io/gh/0h-n0/view-lockfile)
[![Maintainability](https://api.codeclimate.com/v1/badges/9a8b4b39d3673ccb6db6/maintainability)](https://codeclimate.com/github/0h-n0/simple-lock/maintainability)
# simple-lock
> Note
Simple-lockfile uses a file as a lock system.
## Coencept
## How to use
The following example is based on Django project. With this module, you can lock a view method in your app.
```settings.py
from simple_lock import SimpleLock
# ~~~
File.set_root_path('/home/hoge/')
# A lockfile is created in the root_path directory without setting path as arguments.
```
```app/view.py
from response_lockfile import lock_lockfile
# ~~~
@lock_view(name='lockfile1.lock')
def view():
#some_logic
return HttpResponse()
```
This decoreator creates lockfile1.lock and releases.
```app2/view.py
from response_lockfile import watch_lockfile
# ~~~
@watch_lockfile(name='lockfile1.lock')
def view():
return HttpResponse()
```
If lockfile1.lock exists when execute app2/view:view, this decoreator returns a http response.
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
simple_lock-1.0.5.tar.gz
(3.8 kB
view hashes)