Clean up readme

Signed-off-by: Gora Khargosh <gora.khargosh@gmail.com>
1 file changed
tree: 083ab4a47de34415c8bfb7fda3301479c26e5594
  1. doc/
  2. watchdog/
  3. .gitignore
  4. AUTHORS
  5. bootstrap
  6. bootstrap.py
  7. buildout.cfg
  8. LICENSE
  9. MANIFEST.in
  10. README.md
  11. setup.py
  12. watchmedo
  13. watchmedo.bat
README.md

Watchdog

Python API to monitor file system events.

Example Usage:

Supported Platforms:

  • Linux (inotify)
  • Mac OS X (FSEevnts, kqueue)
  • FreeBSD/BSD (kqueue)
  • Windows (ReadDirectoryChangesW with I/O completion ports; ReadDirectoryChangesW worker threads)
  • OS-independent (polling the disk for directory snapshots and comparing them periodically; slow and not recommended)

Dependencies:

  1. pywin32 (only on Windows)
  2. pyinotify (only on Linux)
  3. XCode or gcc (only on Mac OS X)
  4. PyYAML
  5. argh
  6. select_backport (select.kqueue replacement for Python2.5/2.6 on BSD/Mac OS X)

Licensing:

Watchdog is licensed under the terms of the MIT License

Copyright (C) 2010 Gora Khargosh <gora.khargosh@gmail.com> and the Watchdog authors.

Project source code at Github

Please report bugs at the Github issue tracker.