1.. watchdog documentation master file, created by 2 sphinx-quickstart on Tue Nov 30 00:43:58 2010. 3 You can adapt this file completely to your liking, but it should at least 4 contain the root `toctree` directive. 5 6.. include:: global.rst.inc 7 8 9Watchdog 10======== 11 12Python API library and shell utilities to monitor file system events. 13 14Works on 3.9+. 15 16Directory monitoring made easy with 17----------------------------------- 18 19* A cross-platform API. 20 21* A shell tool to run commands in response to directory changes. 22 23Get started quickly with a simple example in :ref:`quickstart`. 24 25Easy installation 26----------------- 27You can use pip_ to install |project_name| quickly and easily:: 28 29 $ python -m pip install -U watchdog 30 31Need more help with installing? See :ref:`installation`. 32 33 34User's Guide 35============ 36 37.. toctree:: 38 :maxdepth: 2 39 40 installation 41 quickstart 42 api 43 hacking 44 45Contribute 46========== 47 48Found a bug in or want a feature added to |project_name|? 49You can fork the official `code repository`_ or file an issue ticket 50at the `issue tracker`_. You may also want to refer to :ref:`hacking` 51for information about contributing code or documentation to |project_name|. 52 53 54Indices and tables 55================== 56 57* :ref:`genindex` 58* :ref:`modindex` 59* :ref:`search` 60 61