watchfiles

1.1.1 · active · verified Sat Mar 28

A simple, modern, and high-performance file watching and code reloading library for Python, currently at version 1.1.1, with a release cadence of approximately every 3-4 months.

Warnings

breaking The package was previously named 'watchgod'.
Fix: Rename imports from 'watchgod' to 'watchfiles'.
deprecated Python 3.8 support was dropped in version 0.24.0.
Fix: Upgrade to Python 3.9 or later.
gotcha Ensure that the 'notify' Rust library is installed for optimal performance.
Fix: Install the 'notify' Rust library as per the installation instructions.

Install

pip install watchfiles Install watchfiles

Imports

watch
```
from watchfiles import watch
```
Correct import path for the 'watch' function.
awatch
```
from watchfiles import awatch
```
Correct import path for the 'awatch' function.
run_process
```
from watchfiles import run_process
```
Correct import path for the 'run_process' function.
arun_process
```
from watchfiles import arun_process
```
Correct import path for the 'arun_process' function.

Quickstart

A simple script to monitor changes in a directory using the 'watch' function from watchfiles.

from watchfiles import watch

for changes in watch('./path/to/dir'):
    print(changes)

view raw JSON →