reactpy_django 3.8.1__tar.gz

reactpy_django-3.8.1/LICENSE.md

@@ -0,0 +1,9 @@
+## The MIT License (MIT)
+
+#### Copyright (c) Reactive Python and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

reactpy_django-3.8.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include src/reactpy_django/py.typed
+recursive-include src/reactpy_django/static *
+recursive-include src/reactpy_django/templates *.html

reactpy_django-3.8.1/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: reactpy_django
+Version: 3.8.1
+Summary: It's React, but in Python. Now with Django integration.
+Home-page: https://github.com/reactive-python/reactpy-django
+Author: Mark Bakhit
+Author-email: archiethemonger@gmail.com
+License: MIT
+Keywords: interactive,reactive,widgets,DOM,React,ReactJS,ReactPy
+Platform: Linux
+Platform: Mac OS X
+Platform: Windows
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Environment :: Web Environment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: channels>=4.0.0
+Requires-Dist: django>=4.2.0
+Requires-Dist: reactpy<1.1.0,>=1.0.2
+Requires-Dist: reactpy-router<1.0.0,>=0.1.1
+Requires-Dist: aiofile>=3.0
+Requires-Dist: dill>=0.3.5
+Requires-Dist: orjson>=3.6.0
+Requires-Dist: nest_asyncio>=1.5.0
+Requires-Dist: typing_extensions
+
+# <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" align="left" height="45"/> ReactPy Django
+
+<p>
+    <a href="https://github.com/reactive-python/reactpy-django/actions?query=workflow%3ATest">
+        <img src="https://github.com/reactive-python/reactpy-django/workflows/Test/badge.svg?event=push">
+    </a>
+    <a href="https://pypi.python.org/pypi/reactpy-django">
+        <img src="https://img.shields.io/pypi/v/reactpy-django.svg?label=PyPI">
+    </a>
+    <a href="https://github.com/reactive-python/reactpy-django/blob/main/LICENSE.md">
+        <img src="https://img.shields.io/badge/License-MIT-purple.svg">
+    </a>
+    <a href="https://reactive-python.github.io/reactpy-django/">
+        <img src="https://img.shields.io/website?down_message=offline&label=Docs&logo=read%20the%20docs&logoColor=white&up_message=online&url=https%3A%2F%2Freactive-python.github.io%2Freactpy-django%2F">
+    </a>
+    <a href="https://discord.gg/uNb5P4hA9X">
+        <img src="https://img.shields.io/discord/1111078259854168116?label=Discord&logo=discord">
+    </a>
+</p>
+
+[ReactPy-Django](https://github.com/reactive-python/reactpy-django) is used to add [ReactPy](https://reactpy.dev/) support to an existing **Django project**. This package also turbocharges ReactPy with features such as...
+
+-   [SEO compatible rendering](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#reactpy_prerender)
+-   [Single page application (SPA) capabilities](https://reactive-python.github.io/reactpy-django/latest/reference/router/#django-router)
+-   [Distributed computing](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#reactpy_default_hosts)
+-   [Performance enhancements](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#performance-settings)
+-   [Customizable reconnection behavior](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#stability-settings)
+-   [Customizable disconnection behavior](https://reactive-python.github.io/reactpy-django/latest/reference/template-tag)
+-   [Multiple root components](https://reactive-python.github.io/reactpy-django/latest/reference/template-tag/)
+-   [Cross-process communication/signaling (Channel Layers)](https://reactive-python.github.io/reactpy-django/latest/reference/hooks/#use-channel-layer)
+-   [Django view to ReactPy component conversion](https://reactive-python.github.io/reactpy-django/latest/reference/components/#view-to-component)
+-   [Django static file access](https://reactive-python.github.io/reactpy-django/latest/reference/components/#django-css)
+-   [Django database access](https://reactive-python.github.io/reactpy-django/latest/reference/hooks/#use-query)
+
+## What is ReactPy?
+
+[ReactPy](https://reactpy.dev/) is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components that look and behave similar to those found in [ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions.
+
+<table align="center">
+    <thead>
+        <tr>
+            <th colspan="2" style="text-align: center">Supported Backends</th>
+        <tr>
+            <th style="text-align: center">Built-in</th>
+            <th style="text-align: center">External</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+        <td>
+            <a href="https://reactpy.dev/docs/guides/getting-started/installing-reactpy.html#officially-supported-servers">
+                Flask, FastAPI, Sanic, Tornado
+            </a>
+        </td>
+        <td>
+            <a href="https://github.com/reactive-python/reactpy-django">Django</a>,
+            <a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>,
+            <a href="https://github.com/idom-team/idom-dash">Plotly-Dash</a>
+        </td>
+        </tr>
+    </tbody>
+</table>
+
+# At a Glance
+
+## `my_app/components.py`
+
+<!--py-header-start-->
+
+You will need a file to define your [ReactPy](https://github.com/reactive-python/reactpy) components. We recommend creating a `components.py` file within your chosen **Django app** to start out. Within this file, we will create a simple `hello_world` component.
+
+<!--py-header-end-->
+<!--py-code-start-->
+
+```python
+from reactpy import component, html
+
+@component
+def hello_world(recipient: str):
+    return html.h1(f"Hello {recipient}!")
+```
+
+<!--py-code-end-->
+
+## [`my_app/templates/my-template.html`](https://docs.djangoproject.com/en/dev/topics/templates/)
+
+<!--html-header-start-->
+
+In your **Django app**'s HTML template, you can now embed your ReactPy component using the `component` template tag. Within this tag, you will need to type in the dotted path to the component.
+
+Additionally, you can pass in `args` and `kwargs` into your component function. After reading the code below, pay attention to how the function definition for `hello_world` (_from the previous example_) accepts a `recipient` argument.
+
+<!--html-code-start-->
+
+```jinja
+{% load reactpy %}
+<!DOCTYPE html>
+<html>
+  <body>
+    {% component "example_project.my_app.components.hello_world" recipient="World" %}
+  </body>
+</html>
+```
+
+<!--html-code-end-->
+
+# Resources
+
+Follow the links below to find out more about this project.
+
+-   [Try ReactPy (Jupyter Notebook)](https://mybinder.org/v2/gh/reactive-python/reactpy-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb)
+-   [Documentation](https://reactive-python.github.io/reactpy-django)
+-   [GitHub Discussions](https://github.com/reactive-python/reactpy-django/discussions)
+-   [Discord](https://discord.gg/uNb5P4hA9X)
+-   [Contributor Guide](https://reactive-python.github.io/reactpy-django/latest/about/code/)
+-   [Code of Conduct](https://github.com/reactive-python/reactpy-django/blob/main/CODE_OF_CONDUCT.md)

reactpy_django-3.8.1/README.md

@@ -0,0 +1,116 @@
+# <img src="https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg" align="left" height="45"/> ReactPy Django
+
+<p>
+    <a href="https://github.com/reactive-python/reactpy-django/actions?query=workflow%3ATest">
+        <img src="https://github.com/reactive-python/reactpy-django/workflows/Test/badge.svg?event=push">
+    </a>
+    <a href="https://pypi.python.org/pypi/reactpy-django">
+        <img src="https://img.shields.io/pypi/v/reactpy-django.svg?label=PyPI">
+    </a>
+    <a href="https://github.com/reactive-python/reactpy-django/blob/main/LICENSE.md">
+        <img src="https://img.shields.io/badge/License-MIT-purple.svg">
+    </a>
+    <a href="https://reactive-python.github.io/reactpy-django/">
+        <img src="https://img.shields.io/website?down_message=offline&label=Docs&logo=read%20the%20docs&logoColor=white&up_message=online&url=https%3A%2F%2Freactive-python.github.io%2Freactpy-django%2F">
+    </a>
+    <a href="https://discord.gg/uNb5P4hA9X">
+        <img src="https://img.shields.io/discord/1111078259854168116?label=Discord&logo=discord">
+    </a>
+</p>
+
+[ReactPy-Django](https://github.com/reactive-python/reactpy-django) is used to add [ReactPy](https://reactpy.dev/) support to an existing **Django project**. This package also turbocharges ReactPy with features such as...
+
+-   [SEO compatible rendering](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#reactpy_prerender)
+-   [Single page application (SPA) capabilities](https://reactive-python.github.io/reactpy-django/latest/reference/router/#django-router)
+-   [Distributed computing](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#reactpy_default_hosts)
+-   [Performance enhancements](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#performance-settings)
+-   [Customizable reconnection behavior](https://reactive-python.github.io/reactpy-django/latest/reference/settings/#stability-settings)
+-   [Customizable disconnection behavior](https://reactive-python.github.io/reactpy-django/latest/reference/template-tag)
+-   [Multiple root components](https://reactive-python.github.io/reactpy-django/latest/reference/template-tag/)
+-   [Cross-process communication/signaling (Channel Layers)](https://reactive-python.github.io/reactpy-django/latest/reference/hooks/#use-channel-layer)
+-   [Django view to ReactPy component conversion](https://reactive-python.github.io/reactpy-django/latest/reference/components/#view-to-component)
+-   [Django static file access](https://reactive-python.github.io/reactpy-django/latest/reference/components/#django-css)
+-   [Django database access](https://reactive-python.github.io/reactpy-django/latest/reference/hooks/#use-query)
+
+## What is ReactPy?
+
+[ReactPy](https://reactpy.dev/) is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components that look and behave similar to those found in [ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions.
+
+<table align="center">
+    <thead>
+        <tr>
+            <th colspan="2" style="text-align: center">Supported Backends</th>
+        <tr>
+            <th style="text-align: center">Built-in</th>
+            <th style="text-align: center">External</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+        <td>
+            <a href="https://reactpy.dev/docs/guides/getting-started/installing-reactpy.html#officially-supported-servers">
+                Flask, FastAPI, Sanic, Tornado
+            </a>
+        </td>
+        <td>
+            <a href="https://github.com/reactive-python/reactpy-django">Django</a>,
+            <a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>,
+            <a href="https://github.com/idom-team/idom-dash">Plotly-Dash</a>
+        </td>
+        </tr>
+    </tbody>
+</table>
+
+# At a Glance
+
+## `my_app/components.py`
+
+<!--py-header-start-->
+
+You will need a file to define your [ReactPy](https://github.com/reactive-python/reactpy) components. We recommend creating a `components.py` file within your chosen **Django app** to start out. Within this file, we will create a simple `hello_world` component.
+
+<!--py-header-end-->
+<!--py-code-start-->
+
+```python
+from reactpy import component, html
+
+@component
+def hello_world(recipient: str):
+    return html.h1(f"Hello {recipient}!")
+```
+
+<!--py-code-end-->
+
+## [`my_app/templates/my-template.html`](https://docs.djangoproject.com/en/dev/topics/templates/)
+
+<!--html-header-start-->
+
+In your **Django app**'s HTML template, you can now embed your ReactPy component using the `component` template tag. Within this tag, you will need to type in the dotted path to the component.
+
+Additionally, you can pass in `args` and `kwargs` into your component function. After reading the code below, pay attention to how the function definition for `hello_world` (_from the previous example_) accepts a `recipient` argument.
+
+<!--html-code-start-->
+
+```jinja
+{% load reactpy %}
+<!DOCTYPE html>
+<html>
+  <body>
+    {% component "example_project.my_app.components.hello_world" recipient="World" %}
+  </body>
+</html>
+```
+
+<!--html-code-end-->
+
+# Resources
+
+Follow the links below to find out more about this project.
+
+-   [Try ReactPy (Jupyter Notebook)](https://mybinder.org/v2/gh/reactive-python/reactpy-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb)
+-   [Documentation](https://reactive-python.github.io/reactpy-django)
+-   [GitHub Discussions](https://github.com/reactive-python/reactpy-django/discussions)
+-   [Discord](https://discord.gg/uNb5P4hA9X)
+-   [Contributor Guide](https://reactive-python.github.io/reactpy-django/latest/about/code/)
+-   [Code of Conduct](https://github.com/reactive-python/reactpy-django/blob/main/CODE_OF_CONDUCT.md)

reactpy_django-3.8.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "nodejs-bin==18.4.0a4"]
+build-backend = "setuptools.build_meta"
+
+[tool.mypy]
+exclude = ['migrations/.*']
+ignore_missing_imports = true
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true
+
+[tool.ruff.lint.isort]
+known-first-party = ["src", "tests"]
+
+[tool.ruff.lint]
+ignore = ["E501"]
+
+[tool.ruff]
+extend-exclude = ["*/migrations/*", ".venv/*", ".eggs/*", ".nox/*", "build/*"]
+line-length = 120

reactpy_django-3.8.1/setup.cfg

@@ -0,0 +1,7 @@
+[bdist_wheel]
+universal = 1
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

reactpy_django-3.8.1/setup.py

@@ -0,0 +1,141 @@
+from __future__ import annotations, print_function
+
+import sys
+import traceback
+from distutils import log
+from pathlib import Path
+
+from nodejs import npm
+from setuptools import find_namespace_packages, setup
+from setuptools.command.develop import develop
+from setuptools.command.sdist import sdist
+
+# -----------------------------------------------------------------------------
+# Basic Constants
+# -----------------------------------------------------------------------------
+name = "reactpy_django"
+root_dir = Path(__file__).parent
+src_dir = root_dir / "src"
+package_dir = src_dir / name
+
+
+# -----------------------------------------------------------------------------
+# Package Definition
+# -----------------------------------------------------------------------------
+package = {
+    "name": name,
+    "python_requires": ">=3.9",
+    "packages": find_namespace_packages(src_dir),
+    "package_dir": {"": "src"},
+    "description": "It's React, but in Python. Now with Django integration.",
+    "author": "Mark Bakhit",
+    "author_email": "archiethemonger@gmail.com",
+    "url": "https://github.com/reactive-python/reactpy-django",
+    "license": "MIT",
+    "platforms": "Linux, Mac OS X, Windows",
+    "keywords": [
+        "interactive",
+        "reactive",
+        "widgets",
+        "DOM",
+        "React",
+        "ReactJS",
+        "ReactPy",
+    ],
+    "include_package_data": True,
+    "zip_safe": False,
+    "classifiers": [
+        "Framework :: Django",
+        "Framework :: Django :: 4.0",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Science/Research",
+        "Topic :: Multimedia :: Graphics",
+        "Environment :: Web Environment",
+    ],
+}
+
+
+# -----------------------------------------------------------------------------
+# Library Version
+# -----------------------------------------------------------------------------
+for line in (package_dir / "__init__.py").read_text().split("\n"):
+    if line.startswith("__version__ = "):
+        package["version"] = eval(line.split("=", 1)[1])
+        break
+else:
+    print(f"No version found in {package_dir}/__init__.py")
+    sys.exit(1)
+
+
+# -----------------------------------------------------------------------------
+# Requirements
+# -----------------------------------------------------------------------------
+requirements: list[str] = []
+with (root_dir / "requirements" / "pkg-deps.txt").open() as f:
+    requirements.extend(line for line in map(str.strip, f) if not line.startswith("#"))
+package["install_requires"] = requirements
+
+
+# -----------------------------------------------------------------------------
+# Library Description
+# -----------------------------------------------------------------------------
+with (root_dir / "README.md").open() as f:
+    long_description = f.read()
+
+package["long_description"] = long_description
+package["long_description_content_type"] = "text/markdown"
+
+
+# ----------------------------------------------------------------------------
+# Build Javascript
+# ----------------------------------------------------------------------------
+def build_javascript_first(build_cls: type):
+    class Command(build_cls):
+        def run(self):
+            js_dir = str(src_dir / "js")
+
+            log.info("Installing Javascript...")
+            result = npm.call(["install"], cwd=js_dir)
+            if result != 0:
+                log.error(traceback.format_exc())
+                log.error("Failed to install Javascript")
+                raise RuntimeError("Failed to install Javascript")
+
+            log.info("Building Javascript...")
+            result = npm.call(["run", "build"], cwd=js_dir)
+            if result != 0:
+                log.error(traceback.format_exc())
+                log.error("Failed to build Javascript")
+                raise RuntimeError("Failed to build Javascript")
+
+            log.info("Successfully built Javascript")
+            super().run()
+
+    return Command
+
+
+package["cmdclass"] = {
+    "sdist": build_javascript_first(sdist),
+    "develop": build_javascript_first(develop),
+}
+
+if sys.version_info < (3, 10, 6):
+    from distutils.command.build import build
+
+    package["cmdclass"]["build"] = build_javascript_first(build)
+else:
+    from setuptools.command.build_py import build_py
+
+    package["cmdclass"]["build_py"] = build_javascript_first(build_py)
+
+
+# -----------------------------------------------------------------------------
+# Installation
+# -----------------------------------------------------------------------------
+if __name__ == "__main__":
+    setup(**package)

reactpy_django-3.8.1/src/reactpy_django/__init__.py

@@ -0,0 +1,28 @@
+import contextlib
+
+import nest_asyncio
+
+from reactpy_django import checks, components, decorators, hooks, router, types, utils
+from reactpy_django.websocket.paths import (
+    REACTPY_WEBSOCKET_PATH,
+    REACTPY_WEBSOCKET_ROUTE,
+)
+
+__version__ = "3.8.1"
+__all__ = [
+    "REACTPY_WEBSOCKET_PATH",
+    "REACTPY_WEBSOCKET_ROUTE",
+    "hooks",
+    "components",
+    "decorators",
+    "types",
+    "utils",
+    "checks",
+    "router",
+]
+
+# Fixes bugs with REACTPY_BACKHAUL_THREAD + built-in asyncio event loops.
+# Previously, Uvicorn could generate `assert f is self._write_fut` exceptions, and Daphne
+# had jittery rendering behaviors. Demonstrated using our "Renders Per Second" test page.
+with contextlib.suppress(ValueError):
+    nest_asyncio.apply()

reactpy_django-3.8.1/src/reactpy_django/apps.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+
+from reactpy_django.utils import RootComponentFinder
+
+
+class ReactPyConfig(AppConfig):
+    name = "reactpy_django"
+
+    def ready(self):
+        # Populate the ReactPy component registry when Django is ready
+        RootComponentFinder().run()