Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic setup and importing instructions in the README #32

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+11 −4
Open

Basic setup and importing instructions in the README #32

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acc2118
More basic instructions on how to initialise and where to import the …
alexagrf Sep 9, 2016
bc926df
Get the formatting right
alexagrf Sep 9, 2016
f1175c8
Read the instructions, get the syntax right
alexagrf Sep 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,23 @@ Django-locking
==============
Usage
-----
The simplest use is by using it as a context manager:

Add 'locking' to your INSTALLED_APPS settings, and run migrate to initialise
create the basic table::

python manage.py migrate


The simplest use is by using it as a context manager

::

from locking.models import NonBlockingLock, AlreadyLocked

with NonBlockingLock.objects.acquire_lock(obj=model_obj):
model_obj.do_something()

Or you can keep track of the lock yourself:

::
Or you can keep track of the lock yourself::

try:
lock = NonBlockingLock.objects.acquire_lock(obj=model_obj)
Expand Down