Watchdog

Python API library and shell utilities to monitor file system events.

Works on 3.9+.

Directory monitoring made easy with

• A cross-platform API.

• A shell tool to run commands in response to directory changes.

Get started quickly with a simple example in Quickstart.

Easy installation

You can use pip to install watchdog quickly and easily:

$ python -m pip install -U watchdog

Need more help with installing? See Installation.

User’s Guide

• Installation
  • Installing from PyPI using pip
  • Installing from source tarballs
  • Installing from the code repository
  • Dependencies
  • Supported Platforms (and Caveats)
• Quickstart
  • A Simple Example
  • Typing
• API Reference
  • watchdog.events
  • watchdog.observers.api
  • watchdog.observers
  • watchdog.observers.polling
  • watchdog.utils
  • watchdog.utils.dirsnapshot
  • watchdog.tricks
• Contributing
  • Important URLs
  • Before you start
  • Setting up the Work Environment

Contribute

Found a bug in or want a feature added to watchdog? You can fork the official code repository or file an issue ticket at the issue tracker. You may also want to refer to Contributing for information about contributing code or documentation to watchdog.

Indices and tables

• Index

• Module Index

• Search Page