README.rst

   1 Note: This package is **deprecated**. It is highly preferred that instead of
   2 using this code base that instead `fasteners`_ or `oslo.concurrency`_ is
   3 used instead. For any questions or comments or further help needed
   4 please email `openstack-dev`_ and prefix your email subject
   5 with ``[oslo][pylockfile]`` (for a faster response).
   6
   7 The lockfile package exports a LockFile class which provides a simple API for
   8 locking files.  Unlike the Windows msvcrt.locking function, the fcntl.lockf
   9 and flock functions, and the deprecated posixfile module, the API is
  10 identical across both Unix (including Linux and Mac) and Windows platforms.
  11 The lock mechanism relies on the atomic nature of the link (on Unix) and
  12 mkdir (on Windows) system calls.  An implementation based on SQLite is also
  13 provided, more as a demonstration of the possibilities it provides than as
  14 production-quality code.
  15
  16 Note: In version 0.9 the API changed in two significant ways:
  17
  18  * It changed from a module defining several classes to a package containing
  19    several modules, each defining a single class.
  20
  21  * Where classes had been named SomethingFileLock before the last two words
  22    have been reversed, so that class is now SomethingLockFile.
  23
  24 The previous module-level definitions of LinkFileLock, MkdirFileLock and
  25 SQLiteFileLock will be retained until the 1.0 release.
  26
  27 To install:
  28
  29     python setup.py install
  30
  31 * Documentation: http://docs.openstack.org/developer/pylockfile
  32 * Source: http://git.openstack.org/cgit/openstack/pylockfile
  33 * Bugs: http://bugs.launchpad.net/pylockfile