LiveReload
Reload webpages on changes, without hitting refresh in your browser.
Installation
python-livereload is for web developers who know Python, and is available on PyPI.
$ pip install livereload
Command Line Interface
python-livereload provides a command line utility, livereload, for starting a server in a directory.
By default, it will listen to port 35729, the common port for LiveReload browser extensions.
$ livereload --help usage: livereload [-h] [-p PORT] [-w WAIT] [directory] Start a `livereload` server positional arguments: directory Directory to watch for changes optional arguments: -h, --help show this help message and exit -p PORT, --port PORT Port to run `livereload` server on -w WAIT, --wait WAIT Time delay before reloading
Older versions of python-livereload used a Guardfile to describe optional additional rules for files to watch and build commands to run on changes. This conflicted with other tools that used the same file for their configuration and is no longer supported since python-livereload 2.0.0. Instead of a Guardfile you can now write a Python script using very similar syntax and run it instead of the command line application.
Developer Guide
The new livereload server is designed for developers. It can power a wsgi application now:
from livereload import Server, shell
server = Server(wsgi_app)
# run a shell command
server.watch('static/*.stylus', 'make static')
# run a function
def alert():
print('foo')
server.watch('foo.txt', alert)
# output stdout into a file
server.watch('style.less', shell('lessc style.less', output='style.css'))
server.serve()
The Server class accepts parameters:
- app: a wsgi application
- watcher: a watcher instance, you don't have to create one
server.watch
server.watch can watch a filepath, a directory and a glob pattern:
server.watch('path/to/file.txt')
server.watch('directory/path/')
server.watch('glob/*.pattern')
You can also use other library (for example: formic) for more powerful file adding:
for filepath in formic.FileSet(include="**.css"):
server.watch(filepath, 'make css')
You can delay a certain seconds to send the reload signal:
# delay 2 seconds for reloading
server.watch('path/to/file', delay=2)
server.setHeader
`server.setHeader` can be used to add one or more headers to the HTTP response:
server.setHeader('Access-Control-Allow-Origin', '*')
server.setHeader('Access-Control-Allow-Methods', '*')
server.serve
Setup a server with server.serve method. It can create a static server and a livereload server:
# use default settings server.serve() # livereload on another port server.serve(liveport=35729) # use custom host and port server.serve(port=8080, host='localhost') # open the web browser on startup, based on $BROWSER environment variable server.serve(open_url_delay=5, debug=False) # set a custom default file to open server.serve(default_filename='example.html')
shell
The powerful shell function will help you to execute shell commands. You can use it with server.watch:
# you can redirect command output to a file
server.watch('style.less', shell('lessc style.less', output='style.css'))
# commands can be a list
server.watch('style.less', shell(['lessc', 'style.less'], output='style.css'))
# working with Makefile
server.watch('assets/*.styl', shell('make assets', cwd='assets'))
Frameworks Integration
Livereload can work seamlessly with your favorite framework.
Django
For Django there is a management command included.
To use simply
- add
'livereload'to yourINSTALLED_APPSand - then run
./manage.py livereload.
For available options like host and ports please refer to ./manage.py livereload -h.
To automagically serve static files like the native runserver command you have to use dj-static. (follow the simple instructions there).
Flask
Wrap Flask with livereload is much simpler:
# app is a Flask object
app = create_app()
# remember to use DEBUG mode for templates auto reload
# https://github.com/lepture/python-livereload/issues/144
app.debug = True
server = Server(app.wsgi_app)
# server.watch
server.serve()
Bottle
Wrap the Bottle app with livereload server:
# Without this line templates won't auto reload because of caching.
# http://bottlepy.org/docs/dev/tutorial.html#templates
bottle.debug(True)
app = Bottle()
server = Server(app)
# server.watch
server.serve()
Security Report
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
7.6k Jan 01, 2023
1.4k Jan 01, 2023
1.7k Dec 24, 2022
2.3k Jan 01, 2023
2.2k Jan 06, 2023
871 Dec 25, 2022
2.9k Dec 21, 2022
738 Jan 09, 2023
1.2k Dec 30, 2022
1.3k Dec 15, 2022
8.7k Jan 01, 2023
1.8k Dec 30, 2022
15.2k Jan 01, 2023
756 Dec 22, 2022
16 Oct 21, 2021
249 Dec 14, 2022
5.9k Dec 28, 2022
917 Oct 04, 2022
343 Dec 22, 2022