Privex Django Lock Manager (django-lockmgr) documentation¶
Welcome to the documentation for Privex’s Django Lock Manager - a small, open source Python 3 package for Django, designed to provide simple, frustration free locks in your Django application, without requiring any additional services like Redis / Memcached.
This documentation is automatically kept up to date by ReadTheDocs, as it is automatically re-built each time a new commit is pushed to the Github Project
Contents
Quick install¶
Installing with Pipenv (recommended)
pipenv install django-lockmgr
Installing with standard pip3
pip3 install django-lockmgr
Add lockmgr to your INSTALLED_APPS
INSTALLED_APPS = [
'django.contrib.admin.apps.SimpleAdminConfig',
'django.contrib.auth',
'django.contrib.contenttypes',
# ...
'lockmgr'
]
Run the migrations
./manage.py migrate lockmgr
All Documentation¶
- How to use the unit tests
- Unit Test List / Overview
- tests.test_lockmgr
- tests.test_lockmgr_class
- tests.test_renew
- TestLockRenew
- Methods
- test_lockmgr_renew_expired
- test_lockmgr_renew_main
- test_renew_existing_name
- test_renew_existing_name_add_time
- test_renew_existing_object_add_time
- test_renew_lock_object
- test_renew_non_existing_name
- test_renew_non_existing_name_create
- test_renew_shorter_expiration
- test_renew_shorter_expiration_add_time
- Attributes
- Methods
- TestLockRenew