.. image:: https://readthedocs.org/projects/inotify-lite/badge/?version=latest :target: https://inotify-lite.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

inotify_lite

inotify_lite provides a Python 3 wrapper around the Linux inotify API. This lets you monitor filesystem events, and execute callbacks. See inotify(7).

• homepage_
• documentation_
• issue tracker_

Requires

• Linux >= 2.6.13 (or glibc >= 2.5)
• Python >= 3.8

Installation

Install inotify_lite by running:

pip install inotify_lite

Usage

To use inotify_lite:

• create an Inotify instance, passing the name of the files (or directories) you wish to watch;

• register a handler (or many), a callable of two arguments:

  • an Inotify instance; and
  • an InotifyEvent instance.

• call Inotify.read to read once, or Inotify.watch to watch until a keyboard interrupt is received.

Example:

.. code-block:: python

  def my_callback(_, event):
print(event.name)
print(event.mask)

  flags = INFlags.CREATE | INFlags.DELETE
  fs_watcher = Inotify("/home/", watch_flags=flags)
  fs_watcher.register_handler(INFlags.ALL_FLAGS, my_callback, exclusive=False)
  fs_watcher.watch()

The TreeWatcher class is provided to recursively watch directories.

See the documentation_ for details and options.

Contribute

Contributions are welcome. Open an issue_ for visibility.

• Issue Tracker: https://github.com/jams2/inotify_lite/issues
• Source Code: https://github.com/jams2/inotify_lite.git

Support

Open an issue_.

License

The project is licensed under GPLv3.

.. _homepage: https://github.com/jams2/inotify_lite .. _documentation: https://inotify-lite.readthedocs.io .. _issue tracker: https://github.com/jams2/inotify_lite/issues .. _issue : https://github.com/jams2/inotify_lite/issues