LiveReload functionality integrated with your Django development environment
Project description
This django app adds a management command that starts a livereload server watching all your static files and templates as well as a custom runserver command that issues livereload requests when the development server is ready after a restart.
Installation
Install package:
$ pip install django-livereload-server
Add 'livereload' to the INSTALLED_APPS, before 'django.contrib.staticfiles' if this is used:
INSTALLED_APPS = ( ... 'livereload', ... )
Add 'livereload.middleware.LiveReloadScript' to MIDDLEWARE_CLASSES (probably at the end):
MIDDLEWARE_CLASSES = ( ... 'livereload.middleware.LiveReloadScript', )
Or to MIDDLEWARE for Django >= 1.10:
MIDDLEWARE = [ ... 'livereload.middleware.LiveReloadScript', ]
This will inject the livereload.js script into your webpages if DEBUG setting is on.
Configuration
If you need the livereload server to use a different host and port than the default 127.0.0.1 and 35729, specify them by setting LIVERELOAD_HOST and LIVERELOAD_PORT in settings.py.
Usage
Start the livereload server:
$ python manage.py livereload
keep the livereload server running.
Start the django development server as usual (in another console):
$ python manage.py runserver
In the browser’s address bar access your web app by doing:
127.0.0.1:8000 or localhost:8000
now every time you hit save in your editor, the django-development-server/livereload-server automatically updates the staticfiles
Customization
By default both template and staticfiles directories are watched.
You can ignore template directories using:
$ ./manage.py livereload --ignore-template-dirs
Or staticfiles directories using:
$ ./manage.py livereload --ignore-static-dirs
Extra files and/or paths to watch for changes can be added as positional arguments. By default livereload server watches the files that are found by your staticfiles finders and your template loaders.
$ python manage.py livereload path/to/my-extra-directory/
This will be excluded from the paths ignored by –ignore-template-dirs and –ignore-static-dirs.
Host and port can be overridden with --host and --port options.
$ python manage.py livereload --host=myhost.com --port=9090
the runserver command python manage.py runserver also accepts three additional options:
* ``--nolivereload`` to disable livereload functionality * ``--livereload-host`` to override both default and settings file specified host address * ``--livereload-port`` to override both default and settings file specified port
Background
This project is based on a merge of python-livereload and django-livereload, excellent projects both and even better for smooth django development when combined.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-livereload-server-0.3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c8da1cb356d9a7fd044d0a50342574aad168522d5d8d25bbdc4ddd9fd196eab |
|
MD5 | a0bbbb1dc6f134d1f1d9b8097c2be7b9 |
|
BLAKE2b-256 | fa6638822076a3088439b39a265d61b17596286812da2325afdcd0882e92c4c1 |