gorakhargosh/watchdog

docs: add more real-world example scripts

オープン

#1,190 opened on 2026/08/04

 (2 件のコメント) (0 件のリアクション) (0 人の担当者)Python (772 件のフォーク)batch import
Good first issueHelp welcome :)documentation

Repository metrics

Stars
 (7,396 個のスター)
PR merge metrics
 (平均マージ 25m) (30d で 1 merged PR)

説明

Description

Following our efforts to improve the documentation and the introduction of the new Examples page, we want to expand our gallery of practical, real-world watchdog configurations.

We would like to invite first-time contributors to add clean, executable example Python scripts for common use cases.

How to contribute:

  1. Choose/Propose a Use Case:
  2. Add a Python script: Create a new Python script under docs/source/examples/ (e.g. docs/source/examples/renaming.py). Make sure it is self-contained and clean.
  3. Link to the docs: Open docs/source/examples.rst and include your script using the literalinclude directive:
    .. literalinclude:: examples/renaming.py
       :language: python
       :linenos:
    
    
  4. Register in tests: Open tests/test_examples.py and add your example script name to the list of tested files so that it gets automatically tested in CI/CD.
  5. Open a PR!

コントリビューターガイド