arel

Browser hot reload for Python ASGI web apps.

Overview

What is this for?

arel can be used to implement development-only hot-reload for non-Python files that are not read from disk on each request. This may include HTML templates, GraphQL schemas, cached rendered Markdown content, etc.

How does it work?

arel watches changes over a set of files. When a file changes, arel notifies the browser (using WebSocket), and an injected client script triggers a page reload. You can register your own reload hooks for any extra server-side operations, such as reloading cached content or re-initializing other server-side resources.

Installation

pip install 'arel==0.2.*'

Quickstart

For a working example using Starlette, see the Example section.

Although the exact instructions to set up hot reload with arel depend on the specifics of your ASGI framework, there are three general steps to follow:

Create an HotReload instance, passing one or more directories of files to watch, and optionally a list of callbacks to call before a reload is triggered:

import arel

async def reload_data():
    print("Reloading server data...")

hotreload = arel.HotReload(
    paths=[
        arel.Path("./server/data", on_reload=[reload_data]),
        arel.Path("./server/static"),
    ],
)

Mount the hot reload endpoint, and register its startup and shutdown event handlers. If using Starlette, this can be done like this:

from starlette.applications import Starlette
from starlette.routing import WebSocketRoute

app = Starlette(
    routes=[WebSocketRoute("/hot-reload", hotreload, name="hot-reload")],
    on_startup=[hotreload.startup],
    on_shutdown=[hotreload.shutdown],
)

Add the JavaScript code to your website HTML. If using Starlette with Jinja templates, you can do this by updating the global environment, then injecting the script into your base template:

templates.env.globals["DEBUG"] = os.getenv("DEBUG")  # Development flag.
templates.env.globals["hotreload"] = hotreload

<body>
  <!-- Page content... -->

  <!-- Hot reload script -->
  {% if DEBUG %}
    {{ hotreload.script(url_for('hot-reload')) | safe }}
  {% endif %}
</body>

Example

The example directory contains an example Markdown-powered website that uses arel to refresh the browser when Markdown content or HTML templates change.

License

MIT

florimondmanca/arel

florimondmanca

Reviews

Repository Details