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