Create better_dash_callback

Signed-off-by: Richard Barella <ribab127@gmail.com>

Author: richard-barella

.github/workflows/workflow.yml

@@ -0,0 +1,35 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches:
+      - main
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build setuptools wheel twine
+
+    - name: Build package
+      run: |
+        python3 -m build
+
+    - name: Publish package
+      run: |
+        twine upload dist/* -u __token__ -p '${{ secrets.PYPI_TOKEN }}'
+

.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+.venv/
+.env/
+env/
+venv/
+build/
+dist/
+*.egg-info/

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Richard Barella Jr.
+
+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.

README.md

@@ -0,0 +1,84 @@
+
+# better-dash-callback
+
+A library that enables running clientside callback functions in Dash applications using Python syntax, eliminating the need for inline JavaScript.
+
+## Problem
+
+When building Dash applications, you often need to write clientside callback functions using inline JavaScript. This can be cumbersome and error-prone, especially for complex logic. Moreover, inline JavaScript code lacks syntax highlighting and debugging capabilities.
+
+## Solution
+
+`better-dash-callback` provides a solution to this problem by allowing you to write clientside callback functions using Python syntax. This makes your code more readable, maintainable, and efficient.
+
+## Example
+
+Let's consider a simple example where we want to update the text of a component based on the value of an input component.
+
+**Using Dash's `clientside_callback`**
+
+```python
+import dash
+from dash import html
+from dash.dependencies import Input, Output
+
+app = dash.Dash(__name__)
+
+app.layout = html.Div([
+    html.Input(id="input", type="text"),
+    html.Div(id="output")
+])
+
+app.clientside_callback(
+    """
+    function(value) {
+        return 'You entered: ' + value;
+    }
+    """,
+    Output("output", "children"),
+    Input("input", "value")
+)
+
+if __name__ == "__main__":
+    app.run_server(debug=True)
+```
+
+**Using `better-dash-callback`**
+
+```python
+import dash
+from dash import html
+from better_dash_callback import callback
+
+app = dash.Dash(__name__)
+
+app.layout = html.Div([
+    html.Input(id="input", type="text"),
+    html.Div(id="output")
+])
+
+@callback(
+    Output("output", "children"),
+    Input("input", "value"),
+    clientside=True
+)
+def update_output(value):
+    return f"You entered: {value}"
+
+if __name__ == "__main__":
+    app.run_server(debug=True)
+```
+
+As you can see, the `better-dash-callback` example is more elegant and easier to read. You can write your callback function using Python syntax, without having to worry about inline JavaScript code.
+
+## Installation
+
+To install `better-dash-callback`, you can use `pip`:
+
+```bash
+pip3 install better-dash-callback
+```
+
+## License
+
+`better-dash-callback` is licensed under the MIT License.

better_dash_callback/__init__.py

@@ -0,0 +1 @@
+from .src import *

better_dash_callback/src.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+import metapensiero.pj.__main__
+import dash
+import inspect
+
+def callback(*args, clientside=False, **kwargs):
+    """
+    A decorator to register a Dash callback. If `clientside` is True, the python callback
+    will be executed clientside using jsbuilder, which will convert it to javascript.
+    
+    If `clientside` is False or not set, the callback will be executed serverside
+    using Dash's standard callback system.
+
+    Other than clientside argument, all other arguments are the same as Dash's @callback function.
+
+    :param clientside: Whether to execute the callback clientside. Defaults to False.
+    """
+    
+    def decorator(func):
+            
+        if clientside:
+            python_code = inspect.getsource(func)
+            python_code = python_code[python_code.find("def "):]
+            js_code = metapensiero.pj.__main__.transform_string(python_code)
+            dash.clientside_callback(js_code, *args, **kwargs)
+        else:
+            @dash.callback(*args, **kwargs)
+            def wrapper(*values):
+                return func(*values)
+
+    return decorator

examples/fibonacci.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+from dash import Dash, html, dcc, Output, Input, State
+from better_dash_callback import callback
+    
+@callback(
+    Output("fibonacci_display", "children"),
+    Output("fibonacci_values", "data"),
+    Input("button", "n_clicks"),
+    State("fibonacci_values", "data"),
+    prevent_initial_call=True,
+    clientside=True
+)
+def compute_next_fibonacci(_, values):
+    """
+    this code will be executed clientside as javascript.
+    This page shows what syntax is supported: https://github.com/metapensiero/metapensiero.pj
+    """
+    ind = 0
+    indices = []
+    while ind < len(values) + 1:
+        indices.push(ind)
+        ind += 1
+    if not values:
+        values = [1]
+    elif len(values) < 2:
+        values.push(1)
+    else:
+        values.push(values[-1] + values[-2])
+    result = ""
+    for i in indices:
+        if i > 0:
+            result += " " + str(values[i])
+        else:
+            result += str(values[i])
+    return result, values
+
+app = Dash(__name__)
+app.layout = [
+    html.Button("Compute Fibonacci", id="button"),
+    html.Span("1", id="fibonacci_display", style={"marginLeft": "10px"}),
+    dcc.Store(id="fibonacci_values", data=[1]),
+]
+
+if __name__ == "__main__":
+    app.run_server(debug=True)

setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='better-dash-callback',
+    version='0.1.0',
+    description='Runs clientside callback functions in Dash applications using Python syntax, eliminating the need for inline JavaScript.',
+    author='Richard Barella Jr.',
+    author_email='codingwithricky@gmail.com',
+    url='https://github.com/ribab/better-dash-callback',
+    packages=find_packages(exclude=['tests', 'examples']),
+    install_requires=[
+        'dash>=2.0.0',
+        'javascripthon==0.13'
+    ],
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries :: Application Frameworks',
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+    ],
+    include_package_data=True,
+)