https://github.com/Fantomas42/django-livereload

Livereload with the Django developement server
https://github.com/Fantomas42/django-livereload

Last synced: 11 days ago
JSON representation

Livereload with the Django developement server

• Host: GitHub
• URL: https://github.com/Fantomas42/django-livereload
• Owner: Fantomas42
• License: bsd-3-clause
• Created: 2014-05-15T13:16:42.000Z (over 10 years ago)
• Default Branch: develop
• Last Pushed: 2017-04-10T09:57:36.000Z (over 7 years ago)
• Last Synced: 2024-10-31T12:25:06.361Z (16 days ago)
• Language: Python
• Size: 28.3 KB
• Stars: 64
• Watchers: 1
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=================

Django-livereload

=================

Application performing a `LiveReload`_ with `tiny-lr`_ once the development

server is ready.

Why this project ?

------------------

I recently started using `Gulp`_ and `LiveReload`_ to automatize some

tasks. Everytime an HTML, CSS or JS file changes, a livereload is performed in

the browser to reflect those changes, and I was pretty happy with that.

But I found one limitation, I cannot perform a livereload of the current

page when editing Python files because the development server provided by

Django is not necessary ready as soon as the livereload request is emitted.

That's why I created this application.

Installation

------------

* First install the package on your system: ::

  $ pip install django-livereload

* Then register the ``'livereload'`` application in your ``INSTALLED_APPS``

  setting, before the ``'django.contrib.staticfiles'`` application if used.

Usage

-----

If the livereload server provided by `tiny-lr` is launched (via `Gulp`_,

`Grunt`_ or whatever), the ``runserver`` command will do a livereload on

your browser whenever the Django development server is ready.

The script

----------

If you want to `livereload-js`_ script injected into your pages because you

don't want to deal with a plug-in, simply register this middleware in your

project: ``'livereload.middleware.LiveReloadScript'``.

.. _`LiveReload`: http://livereload.com/

.. _`tiny-lr`: https://github.com/mklabs/tiny-lr

.. _`Gulp`: http://gulpjs.com/

.. _`Grunt`: http://gruntjs.com/

.. _`livereload-js`: https://github.com/livereload/livereload-js