Integrate Hotwire Turbo with Django allowing for a Python-driven dynamic web experience.
Project description
Turbo for Django
Integrate Hotwire Turbo with Django with ease.
Requirements
- Python 3.8+
- Django 3.1+
- Channels 3.0+ (Optional for Turbo Frames, but needed for Turbo Stream support)
Installation
Turbo Django is available on PyPI - to install it, just run:
pip install turbo-django
Add turbo and channels to INSTALLED_APPS, and copy the following CHANNEL_LAYERS setting:
INSTALLED_APPS = [
...
'turbo',
'channels'
...
]
CHANNEL_LAYERS = {
"default": {
# You will need to `pip install channels_redis` and configure a redis instance.
# Using InMemoryChannelLayer will not work as the memory is not shared between threads.
# See https://channels.readthedocs.io/en/latest/topics/channel_layers.html
"BACKEND": "channels_redis.core.RedisChannelLayer",
"CONFIG": {
"hosts": [("127.0.0.1", 6379)],
},
}
}
And collect static files if the development server is not hosting them:
./manage.py collectstatic
Note: Both Hotwire and this library are still in beta development and may introduce breaking API changes between releases. It is advised to pin the library to a specific version during install.
Quickstart
Want to see Hotwire in action? Here's a simple broadcast that can be setup in less than a minute.
The basics:
-
A Turbo Stream class is declared in python.
-
A template subscribes to the Turbo Stream.
-
HTML is be pushed to all subscribed pages which replaces the content of specified HTML p tag.
Example
First, in a django app called quickstart, declare BroadcastStream in a file named streams.py.
# streams.py
import turbo
class BroadcastStream(turbo.Stream):
pass
Then, create a template that subscribes to the stream.
```python
from django.urls import path
from django.views.generic import TemplateView
urlpatterns = [
path('quickstart/', TemplateView.as_view(template_name='broadcast_example.html'))
]
# broadcast_example.html
{% load turbo_streams %}
<!DOCTYPE html>
<html lang="en">
<head>
{% include "turbo/head.html" %}
</head>
<body>
{% turbo_subscribe 'quickstart:BroadcastStream' %}
<p class="broadcast_box_class" id="broadcast_box">Placeholder for broadcast</p>
</body>
</html>
Now run ./manage.py shell. Import the Turbo Stream and tell the stream to take the current timestamp and update the element with id broadcast_box on all subscribed pages.
from quickstart.streams import BroadcastStream
from datetime import datetime
BroadcastStream().update(text=f"{datetime.now()}: This is a broadcast.", id="broadcast_box")
With the quickstart/ path open in a browser window, watch as the broadcast pushes messages to the page.
Now change .update() to .append() and resend the broadcast a few times. Notice you do not have to reload the page to get this modified behavior.
Excited to learn more? Be sure to walk through the tutorial and read more about what Turbo can do for you.
Documentation
Read the full documentation at readthedocs.io.
Contribute
Discussions about a Django/Hotwire integration are happening on the Hotwire forum. And on Slack, which you can join by clicking here!
As this new magic is discovered, you can expect to see a few repositories with experiments and demos appear in @hotwire-django. If you too are experimenting, we encourage you to ask for write access to the GitHub organization and to publish your work in a @hotwire-django repository.
License
Turbo-Django is released under the MIT License to keep compatibility with the Hotwire project.
If you submit a pull request. Remember to add yourself to CONTRIBUTORS.md!
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
Built Distribution
Hashes for turbo_django-0.3.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 86208982b432d223cbc13b7e241c54eb320febc3073321d37157cc3a3d0eafe6 |
|
| MD5 | 8ac72c298f8ba913f547a16522692c25 |
|
| BLAKE2b-256 | 69acdef944011e8e32f1281147835f4edb9944da3f171f09cb22656c1a164966 |
