~soren/filecache/trunk-fail

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
=========
filecache
=========

Description
===========

`filecache` is a simple file caching library which uses only the file system
to store system state.

With `filecache`:

    * The cache is a *directory*
    * The key is a *filename*
    * The value is a file's *contents*
    * The metadata is the *contents* of the `.<key>.metadata` file
    * The cache is exclusively locked using the `.cache.lock` lockfile
    * A key is exclusively locked using the `.<key>.lock` lockfile
    * The number of readers is maintained by a counting semaphore stored in
      `.<key>.sem`

Dependencies
============

    * setuptools_
    * sharedfile_

Installation
============

To install filecache run::

    wget -q http://github.com/downloads/rconradharris/filecache/Filecache-0.2.1c.tar.gz
    tar -zxf Filecache-0.2.1c.tar.gz
    python setup.py install

Test the install by opening a Python interpreter and running::

    >> from filecache import FileCache
    >> FileCache
    <class 'filecache.FileCache'>

Code License
============

filecache is available under the `MIT License`_.

Bugs
====

Plenty.

Author
======

    * Rick Harris (rconradharris@gmail.com)

Contributors
============

    * Cory Wright


.. _sharedfile: http://github.com/rconradharris/sharedfile
.. _setuptools: http://peak.telecommunity.com/
.. _MIT License: http://www.opensource.org/licenses/mit-license.php