==================================
flufl.lock - An NFS-safe file lock
==================================

This package is called ``flufl.lock``.  It is an NFS-safe file-based lock with
timeouts for POSIX systems.


Requirements
============

``flufl.lock`` requires Python 2.6 or newer, and is compatible with Python 3.


Documentation
=============

A `simple guide`_ to using the library is available within this package, in
the form of doctests.   The manual is also available online in the Cheeseshop
at:

    http://package.python.org/flufl.lock


Project details
===============

The project home page is:

    http://launchpad.net/flufl.lock

You should report bugs at:

    http://bugs.launchpad.net/flufl.lock

You can download the latest version of the package either from the Cheeseshop:

    http://pypi.python.org/pypi/flufl.lock

Of course you can also just install it with ``pip``::

    % sudo pip install flufl.lock

You may want to use `virtualenv`_ instead of installing the package into the
system Python.

You can grab the latest development copy of the code using git.  The master
repository is hosted on Gitorious.  If you have git installed, you can grab
your own branch of the code like this::

    $ git clone git://gitorious.org/flufl-lock/flufl-lock.git

You may contact the author via barry@python.org.


Copyright
=========

Copyright (C) 2004-2014 Barry A. Warsaw

This file is part of flufl.lock.

flufl.lock is free software: you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

flufl.lock is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
details.

You should have received a copy of the GNU Lesser General Public License along
with flufl.lock.  If not, see <http://www.gnu.org/licenses/>.


Table of Contents
=================

.. toctree::
    :glob:

    docs/using
    NEWS

.. _`simple guide`: docs/using.html
.. _`virtualenv`: http://www.virtualenv.org/en/latest/index.html
