Python LiveReload

2.7.1 · active · verified Sun Apr 12

Python LiveReload is a tool for web developers that automatically reloads webpages in the browser when file changes are detected. It provides a WSGI-compatible server and a command-line utility, focusing on simple, real-time feedback during development. The current version is 2.7.1, with a release cadence that includes bug fixes and minor enhancements.

Warnings

breaking The `Guardfile` configuration method was removed in version 2.0.0. Older setups relying on a `Guardfile` will no longer work.
Fix: Rewrite your watch rules using the Python API `server.watch()` within a Python script instead of a `Guardfile`.
gotcha When watching a large number of files, or during a build process that generates many files, `livereload` can trigger excessive reloads and high CPU usage.
Fix: Use the `delay` parameter in `server.watch(filepath, func=None, delay=None)` to debounce reloads, or specify more granular file patterns to watch.
gotcha `livereload` internally uses `Tornado`'s IOLoop. Improper integration with existing `Tornado` applications or other async loops can lead to issues, especially around the loop's lifecycle.
Fix: Ensure that `livereload`'s server and your application's `IOLoop` (if any) are properly managed. Version 2.7.1 includes a fix for IOLoop stopping, but complex `Tornado` integrations may still require careful handling.
gotcha While a command-line interface (`livereload` command) is available, it's recommended to use the Python API for more advanced or custom watching scenarios, especially since the removal of `Guardfile`.
Fix: Create a Python script (e.g., `serve.py`) that imports `Server` and `shell` and defines your watch rules programmatically, then run it with `python serve.py`.
gotcha When running behind a reverse proxy, particularly with HTTPS, the `livereload.js` client might attempt to connect via `ws://` instead of `wss://`, leading to connection errors.
Fix: Configure your reverse proxy to correctly handle WebSocket connections and ensure that the `Host` and `X-Forwarded-Proto` headers are passed through, or specify `liveport` explicitly if needed.

Install

pip install livereload Install stable version

Imports

Server
```
from livereload import Server
```
shell
```
from livereload import shell
```

Quickstart

This quickstart creates a simple HTML file, then starts a LiveReload server that watches for changes to any `.html` files in the current directory. It will automatically open a browser tab to `http://localhost:5500` and reload it when files change.

import os
from livereload import Server, shell

# Create a dummy index.html for demonstration
with open('index.html', 'w') as f:
    f.write('<!DOCTYPE html>\n<html><head><title>LiveReload Test</title></head><body><h1>Hello, LiveReload!</h1></body></html>')

server = Server()
server.watch('*.html')
server.serve(open_url_delay=1)

view raw JSON →