Control the web with Python
Project description
Django IDOM · 
django-idom allows Django to integrate with IDOM, a reactive Python web framework for building interactive websites without needing a single line of Javascript.
You can try IDOM now in a Jupyter Notebook:
Quick Example
example_app/components.py
This is where you'll define your IDOM components. Ultimately though, you should
feel free to organize your component modules as you wish. Any components created will ultimately be referenced
by Python dotted path in your-template.html.
from idom import component, html
from django_idom import IdomWebsocket
# Components are CamelCase by ReactJS convention
@component
def Hello(websocket: IdomWebsocket, greeting_recipient: str):
return html.h1(f"Hello {greeting_recipient}!")
example_app/templates/your-template.html
In your templates, you may add IDOM components into your HTML by using the idom_component
template tag. This tag requires the dotted path to the component function.
Additonally, you can pass in keyworded arguments into your component function.
In context this will look a bit like the following...
{% load idom %}
<!DOCTYPE html>
<html>
<head>
<title>Example Project</title>
</head>
<body>
{% idom_component "my_django_project.example_app.components.Hello" greeting_recipient="World" %}
</body>
</html>
Installation
Install django-idom via pip.
pip install django-idom
You'll also need to modify a few files in your Django project.
settings.py
In your settings you'll need to add channels and django_idom to INSTALLED_APPS.
INSTALLED_APPS = [
...,
"channels",
"django_idom",
]
# Ensure ASGI_APPLICATION is set properly based on your project name!
ASGI_APPLICATION = "my_django_project.asgi.application"
Optional: You can also configure IDOM settings.
# If "idom" cache is not configured, then we'll use "default" instead
CACHES = {
"idom": {"BACKEND": ...},
}
# Maximum seconds between two reconnection attempts that would cause the client give up.
# 0 will disable reconnection.
IDOM_WS_MAX_RECONNECT_TIMEOUT: int = 604800
# The URL for IDOM to serve websockets
IDOM_WEBSOCKET_URL: str = "idom/"
urls.py
Add IDOM HTTP paths to your urlpatterns.
from django.urls import include, path
urlpatterns = [
path("idom/", include("django_idom.http.urls")),
...
]
asgi.py
Register IDOM's websocket using IDOM_WEBSOCKET_PATH.
Note: If you do not have an asgi.py, follow the channels installation guide.
import os
from django.core.asgi import get_asgi_application
# Ensure DJANGO_SETTINGS_MODULE is set properly based on your project name!
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "my_django_project.settings")
django_asgi_app = get_asgi_application()
from channels.auth import AuthMiddlewareStack
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.sessions import SessionMiddlewareStack
from django_idom import IDOM_WEBSOCKET_PATH
application = ProtocolTypeRouter(
{
"http": django_asgi_app,
"websocket": SessionMiddlewareStack(
AuthMiddlewareStack(URLRouter([IDOM_WEBSOCKET_PATH]))
),
}
)
Developer Guide
If you plan to make code changes to this repository, you'll need to install the following dependencies first:
- NPM for installing and managing Javascript
- ChromeDriver for testing with Selenium
Once done, you should clone this repository:
git clone https://github.com/idom-team/django-idom.git
cd django-idom
Then, by running the command below you can:
-
Install an editable version of the Python code
-
Download, build, and install Javascript dependencies
pip install -e . -r requirements.txt
Finally, to verify that everything is working properly, you'll want to run the test suite.
Running The Tests
This repo uses Nox to run scripts which can
be found in noxfile.py. For a full test of available scripts run nox -l. To run the full test suite simple execute:
nox -s test
To run the tests using a headless browser:
nox -s test -- --headless
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
File details
Details for the file django_idom-0.0.4.tar.gz.
File metadata
- Download URL: django_idom-0.0.4.tar.gz
- Upload date:
- Size: 261.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11f8b6e6b89131b02b5295ea83171bfe53b3f3690d08a7b257f338816c60e92c |
|
| MD5 | 9e5d641b863ae2ceb4f51d2eb06f0f5f |
|
| BLAKE2b-256 | 12f5f76cda0fc406d6c3dd085308141f12ca73af2572d36421ea4eb74a554b3e |
File details
Details for the file django_idom-0.0.4-py2.py3-none-any.whl.
File metadata
- Download URL: django_idom-0.0.4-py2.py3-none-any.whl
- Upload date:
- Size: 266.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2fc330d5a463c9ad381caa6440f18ce7a36440ec5a72db60405c2aada6739385 |
|
| MD5 | 1783e0817a42438e5d2b2dcae42d480c |
|
| BLAKE2b-256 | d6f5d1b870ec8873fd1d1d0e3cc003c753471f451fb786cfb343ffa824a13945 |
