RETIRED, Platform-independent file locking module
Go to file
Joshua Harlow 028164a0a4 Add pbr to dependency list
Currently pbr is breaking markup safe usage in docs, the
not so obvious way to fix this is to place pbr in the
explicit requirements for pylockfile.

Closes-Bug: #1384919

Change-Id: I0bba2f28956aeeb70b1e15f82d6bb67fdbd49118
2014-10-27 21:03:17 -07:00
doc/source Fix documentation bug report address 2014-09-17 19:09:49 +02:00
lockfile Merge pull request #3 from cizra/issue-20 2014-05-02 09:00:28 -05:00
test Add missing cover env in tox 2014-09-18 15:43:46 +02:00
.gitignore Add missing cover env in tox 2014-09-18 15:43:46 +02:00
.gitreview Add .gitreview, tox targets and use pbr 2014-09-10 15:19:39 +02:00
ACKS more merge stuff 2011-04-13 02:41:19 +00:00
LICENSE get the structure right 2010-02-09 02:06:54 +00:00
README Update source location. 2013-02-06 09:06:38 -06:00
RELEASE-NOTES more merge stuff 2011-04-13 02:41:19 +00:00
requirements.txt Add pbr to dependency list 2014-10-27 21:03:17 -07:00
setup.cfg Fix package name 2014-09-19 10:12:07 +02:00
setup.py Add .gitreview, tox targets and use pbr 2014-09-10 15:19:39 +02:00
test-requirements.txt The version of sphinx being brought in is broken 2014-10-17 23:46:14 +00:00
tox.ini Add pbr to dependency list 2014-10-27 21:03:17 -07:00

README

The lockfile package exports a LockFile class which provides a simple API for
locking files.  Unlike the Windows msvcrt.locking function, the fcntl.lockf
and flock functions, and the deprecated posixfile module, the API is
identical across both Unix (including Linux and Mac) and Windows platforms.
The lock mechanism relies on the atomic nature of the link (on Unix) and
mkdir (on Windows) system calls.  An implementation based on SQLite is also
provided, more as a demonstration of the possibilities it provides than as
production-quality code.

Note: In version 0.9 the API changed in two significant ways:

 * It changed from a module defining several classes to a package containing
   several modules, each defining a single class.

 * Where classes had been named SomethingFileLock before the last two words
   have been reversed, so that class is now SomethingLockFile.

The previous module-level definitions of LinkFileLock, MkdirFileLock and
SQLiteFileLock will be retained until the 1.0 release.

Available on GitHub from:

    git://github.com/smontanaro/pylockfile.git

To install:

    python setup.py install