About pyinotify:
---------------

pyinotify is a simple Python wrapper for the Linux kernel's inotify
mechanism. The inotify mechanism allows applications to watch file
changes in a fast and clean way since Linux kernel 2.6.13.



What can you use pyinotify for:
------------------------------

- Watch over proper locking procedure on a set of files.
- Trigger software rebuilds on source file modifications.
- FIXME



Requirements:
------------

- Linux 2.6.13+ or every patched kernel supporting inotify.
- Python 2.3+
- C Compiler



Quick start:
-----------

$ cd pyinotify-x-x-x/
$ python setup.py build
$ python src/pyinotify/pyinotify.py '/my-dir-to-watch'

  then play in /my-dir-to-watch (cat x, mkdir y, touch z,...)



Install pyinotify:
-----------------

$ cd pyinotify-x-x-x/
$ python setup.py install

We can now test pyinotify like that:
$ python -m pyinotify '/my-dir-to-watch'

Command line help:
$ python -m pyinotify -h


Note: the location where the files are installed (by default) is

/usr/lib/python2.{3,4}/site-packages/     (or something like that)
    pyinotify.pth
    pyinotify/
        inotify.py
        pyinotify.py
        _inotify.so



License:
-------

GPL-2: GNU General Public License Version 2.



Documentation:
-------------

/NEWS:		       latest changes
/README:               module readme
/doc/index.html:       epydoc documentation
/www/index.html:       webpage
/www/README:           webpage readme
/src/examples/README:  import instructions readme


Examples:
--------

/src/examples/*



Tree:
----

/pyinotify/
  COPYING:	License
  ChangeLog:	ChangeLog
  PKG-INFO:	Package informations
  setup.py:     install module
  setup.cfg:	config file
  MANIFEST.in:	sdist config file
  NEWS:		latest changes
  TODO:		todo
  doc/:		documentation
  src/:		sources
    examples/:  examples
    tests/:     tests
    pyinotify/: pyinotify module
  www/:		web page

