dash-ai-chatbot 1.0.0__py3-none-any.whl

dash_ai_chatbot/__init__.py

@@ -0,0 +1,70 @@
+"""Asyntai AI chat assistant for Plotly Dash apps.
+
+Usage::
+
+    from dash import Dash, html
+    import dash_ai_chatbot
+
+    app = Dash(__name__)
+    app.layout = html.Div('Hello')
+    dash_ai_chatbot.init_app(app, widget_id='asyntai_ab12cd34')
+
+Or, on Dash 3 and later, set ``ASYNTAI_WIDGET_ID`` in the environment and
+change no code at all.
+"""
+from ._core import (
+    DEFAULT_SCRIPT_URL,
+    clean_script_url,
+    clean_widget_id,
+    insert_widget,
+    widget_snippet,
+)
+
+__version__ = '1.0.0'
+
+__all__ = [
+    'DEFAULT_SCRIPT_URL',
+    'clean_script_url',
+    'clean_widget_id',
+    'init_app',
+    'insert_widget',
+    'widget_snippet',
+]
+
+_FLAG = '_asyntai_widget_settings'
+
+
+def init_app(app, widget_id=None, script_url=None):
+    """Add the chat widget to every page of a Dash app.
+
+    ``widget_id`` is the ID from the Install page of the Asyntai dashboard,
+    or the whole snippet copied from there. When it is left out, the
+    ``ASYNTAI_WIDGET_ID`` environment variable is read each time the page is
+    built. ``script_url`` is only for a case where Asyntai support asks you
+    to change it.
+
+    Calling it twice on the same app only updates the values. The app is
+    returned, so the call can be chained.
+    """
+    if not hasattr(app, 'interpolate_index'):
+        raise TypeError('init_app() needs a dash.Dash app.')
+
+    settings = {'widget_id': widget_id, 'script_url': script_url}
+
+    if getattr(app, _FLAG, None) is not None:
+        getattr(app, _FLAG).update(settings)
+        return app
+
+    setattr(app, _FLAG, settings)
+    original = app.interpolate_index
+
+    def interpolate_index(**kwargs):
+        page = original(**kwargs)
+        current = getattr(app, _FLAG)
+        return insert_widget(page, current['widget_id'], current['script_url'])
+
+    # Wrapping the instance method works on Dash 2, 3 and 4, and it also
+    # works when the app sets its own index_string or overrides
+    # interpolate_index in a subclass.
+    app.interpolate_index = interpolate_index
+    return app

dash_ai_chatbot/_core.py

@@ -0,0 +1,144 @@
+"""Everything the package decides about the widget lives here.
+
+Dash serves one HTML page for the whole app, built by ``Dash.interpolate_index``
+and then passed through the ``index`` hooks. The widget goes into that page
+once, just before the closing body tag, so it is on every view of the app,
+including multi-page apps built with ``dash.page_registry``.
+"""
+import html
+import os
+import re
+
+DEFAULT_SCRIPT_URL = 'https://widget.asyntai.com/static/js/chat-widget.js'
+
+#: Environment variables read when no value is passed in code.
+ENV_WIDGET_ID = 'ASYNTAI_WIDGET_ID'
+ENV_SCRIPT_URL = 'ASYNTAI_SCRIPT_URL'
+
+#: Marker that shows the widget is already on the page.
+MARKER = 'asyntai-widget-config'
+
+#: Shape of a widget identifier from the Asyntai dashboard.
+ID_PATTERN = re.compile(r'^asyntai_[A-Za-z0-9]{6,64}$')
+
+#: The identifier inside a pasted snippet.
+SNIPPET_PATTERN = re.compile(r'data-asyntai-id\s*=\s*["\']([^"\']+)["\']')
+
+_HTTPS_PATTERN = re.compile(r'^https://[^\s"\'<>]+$', re.IGNORECASE)
+
+BODY_CLOSE = '</body>'
+
+_LOADER = """<div class="asyntai-widget-config" data-asyntai-widget="{widget_id}" data-asyntai-src="{script_url}" style="display: none"></div>
+<script>
+    // Loads the Asyntai chat widget after the page has finished loading, so
+    // the Dash app draws first. The two values arrive on data attributes,
+    // because nothing is ever written into the script itself.
+    (function () {{
+        var config = document.querySelector('.asyntai-widget-config');
+        if (!config) {{ return; }}
+
+        var widgetId = config.getAttribute('data-asyntai-widget') || '';
+        var scriptUrl = config.getAttribute('data-asyntai-src') || '';
+        if (!widgetId || scriptUrl.indexOf('https://') !== 0) {{ return; }}
+
+        var load = function () {{
+            if (document.querySelector('script[data-asyntai-id]')) {{ return; }}
+
+            var script = document.createElement('script');
+            script.src = scriptUrl;
+            script.async = true;
+            script.setAttribute('data-asyntai-id', widgetId);
+            document.head.appendChild(script);
+        }};
+
+        if (document.readyState === 'complete') {{
+            load();
+        }} else {{
+            window.addEventListener('load', load);
+        }}
+    }}());
+</script>
+"""
+
+
+def clean_widget_id(raw):
+    """Return a usable widget identifier, or an empty string.
+
+    Accepts a bare identifier or the whole snippet from the Asyntai
+    dashboard, because people paste the snippet. An empty string means the
+    chat stays off.
+    """
+    if not isinstance(raw, str):
+        return ''
+
+    value = raw.strip()
+    if not value:
+        return ''
+
+    match = SNIPPET_PATTERN.search(value)
+    if match:
+        value = match.group(1).strip()
+
+    return value if ID_PATTERN.match(value) else ''
+
+
+def clean_script_url(raw):
+    """Return the script address, or an empty string when the value is bad.
+
+    Only an https address is accepted, so a bad value can never put a
+    javascript: URL on the page. None or an empty value means the Asyntai
+    address.
+    """
+    if raw is None:
+        return DEFAULT_SCRIPT_URL
+    if not isinstance(raw, str):
+        return ''
+
+    value = raw.strip()
+    if not value:
+        return DEFAULT_SCRIPT_URL
+
+    return value if _HTTPS_PATTERN.match(value) else ''
+
+
+def widget_snippet(widget_id, script_url=None):
+    """Return the HTML that loads the widget, or an empty string.
+
+    The empty string comes back when the identifier or the address is not
+    valid, so a typo leaves the app as it was instead of breaking it.
+    """
+    clean_id = clean_widget_id(widget_id)
+    clean_url = clean_script_url(script_url)
+    if not clean_id or not clean_url:
+        return ''
+
+    return _LOADER.format(
+        widget_id=html.escape(clean_id, quote=True),
+        script_url=html.escape(clean_url, quote=True),
+    )
+
+
+def insert_widget(page, widget_id=None, script_url=None):
+    """Return the page with the widget added before the closing body tag.
+
+    Values passed in come first; missing ones are read from the environment
+    at the moment the page is built, so a deployment can change the ID
+    without a code change. The page is returned unchanged when there is no
+    valid ID, when it has no body tag, or when the widget is already on it.
+    """
+    if not isinstance(page, str) or MARKER in page:
+        return page
+
+    if widget_id is None:
+        widget_id = os.environ.get(ENV_WIDGET_ID, '')
+    if script_url is None:
+        script_url = os.environ.get(ENV_SCRIPT_URL) or None
+
+    snippet = widget_snippet(widget_id, script_url)
+    if not snippet or BODY_CLOSE not in page:
+        return page
+
+    # Split on the last closing tag, so a page that prints the tag inside an
+    # example or a code block is left alone.
+    head, _, tail = page.rpartition(BODY_CLOSE)
+    return head + snippet + BODY_CLOSE + tail

dash_ai_chatbot/_hooks.py

@@ -0,0 +1,25 @@
+"""Zero-code mode for Dash 3 and later.
+
+Dash loads every module named in a ``dash_hooks`` entry point when an app
+starts. This one registers an ``index`` hook, so the widget appears on every
+Dash app on the machine once ``ASYNTAI_WIDGET_ID`` is set, with no code
+change. Without that variable the hook leaves every page as it was.
+
+Older Dash versions have no hooks; there ``init_app`` does the same job.
+"""
+from ._core import insert_widget
+
+try:
+    from dash import hooks
+except ImportError:  # Dash 2 has no hooks module.
+    hooks = None
+
+
+def _add_widget(page):
+    # Only the environment is read here. An app that called init_app() has
+    # already got the widget, and insert_widget() sees the marker and stops.
+    return insert_widget(page)
+
+
+if hooks is not None and hasattr(hooks, 'index'):
+    hooks.index()(_add_widget)

dash_ai_chatbot-1.0.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: dash-ai-chatbot
+Version: 1.0.0
+Summary: Adds the Asyntai AI chat assistant to a Plotly Dash app. It answers visitor questions from your own content, in more than 80 languages.
+Author-email: Asyntai <hello@asyntai.com>
+License-Expression: MIT
+Project-URL: Homepage, https://asyntai.com
+Project-URL: Documentation, https://asyntai.com/documentation/integrations/plotly-dash/
+Project-URL: Source, https://github.com/asyntai/dash-ai-chatbot
+Project-URL: Issues, https://github.com/asyntai/dash-ai-chatbot/issues
+Keywords: dash,plotly,plotly-dash,chatbot,ai,ai-chatbot,live-chat,customer-support,assistant,widget
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Dash
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dash>=2.0
+Dynamic: license-file
+
+# dash-ai-chatbot
+
+Adds the [Asyntai](https://asyntai.com) AI chat assistant to a
+[Plotly Dash](https://dash.plotly.com) app. The assistant answers visitor
+questions from your own content, day and night, in more than 80 languages.
+
+Free and open source. Works on every Asyntai plan, including the free plan.
+
+- Requires Dash 2.0 or newer and Python 3.10 or newer
+- Documentation: https://asyntai.com/documentation/integrations/plotly-dash/
+
+## Install
+
+```
+pip install dash-ai-chatbot
+```
+
+Add one line after you create the app:
+
+```python
+from dash import Dash, html
+import dash_ai_chatbot
+
+app = Dash(__name__)
+app.layout = html.Div("Hello")
+
+dash_ai_chatbot.init_app(app, widget_id="asyntai_ab12cd34")
+
+if __name__ == "__main__":
+    app.run()
+```
+
+You get the ID from the Install page of your
+[Asyntai dashboard](https://asyntai.com/dashboard). You can paste the whole
+snippet; the package keeps only the ID.
+
+That is all. The chat button appears on every page of the app, including
+multi-page apps.
+
+## No code change (Dash 3 and later)
+
+On Dash 3 and later the package also works with no code change. Install it and
+set one environment variable:
+
+```
+ASYNTAI_WIDGET_ID=asyntai_ab12cd34
+```
+
+Every Dash app that runs with that variable gets the chat. Without the
+variable the package does nothing.
+
+## Keep the ID out of the code
+
+Leave out `widget_id` and the package reads `ASYNTAI_WIDGET_ID` each time the
+page is built:
+
+```python
+dash_ai_chatbot.init_app(app)
+```
+
+## Options
+
+```python
+dash_ai_chatbot.init_app(
+    app,
+    widget_id="asyntai_ab12cd34",  # or the whole snippet; empty or invalid = chat off
+    script_url=None,               # change only if Asyntai support asks you to
+)
+```
+
+`script_url` can also come from the `ASYNTAI_SCRIPT_URL` environment variable.
+Only an `https` address is accepted.
+
+## How it works
+
+Dash serves one HTML page for the whole app. The package puts a small script
+just before the closing body tag of that page. The script waits for the page to
+finish loading, then fetches the chat widget from Asyntai, so your app draws
+first and its speed is unchanged.
+
+The widget ID and the script address travel to the browser on a data
+attribute, never inside the script. The package works with a custom
+`index_string`, with a subclass that overrides `interpolate_index`, and with
+`url_base_pathname`. It never adds the widget twice.
+
+## Tests
+
+```
+pip install -e . pytest
+pytest
+```
+
+## Support
+
+hello@asyntai.com
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

dash_ai_chatbot-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+dash_ai_chatbot/__init__.py,sha256=EEIEG-_1V0Wv3xFYz9XrY0fgn0fs_v3ELozfVPppkAM,2018
+dash_ai_chatbot/_core.py,sha256=aGnSgJy3oLetM1bpYF8ICZds2oscTbgW2RmXRqPe-6k,4890
+dash_ai_chatbot/_hooks.py,sha256=oTk6Mz0fwcK2n5x7fWX-KiUYwya8Sas1v48IwHm3emg,835
+dash_ai_chatbot-1.0.0.dist-info/licenses/LICENSE,sha256=jGsodKzosaT2Pr7P3ahTkLrMTHQ6uvf111OMRXeGYUM,1064
+dash_ai_chatbot-1.0.0.dist-info/METADATA,sha256=F5Ui67eDLFKVYbDRrSGLSqEJTdWLsFpHn8OALOFqBes,3961
+dash_ai_chatbot-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+dash_ai_chatbot-1.0.0.dist-info/entry_points.txt,sha256=0ZmnJjX2h3TFKlFRNVSuyeYrWNAxZ1Uj_QgDEgGc1mE,54
+dash_ai_chatbot-1.0.0.dist-info/top_level.txt,sha256=ZMDPPvwvSe1ixS3BS-_qYgGVI8mspvau9wKnNvaAHEE,16
+dash_ai_chatbot-1.0.0.dist-info/RECORD,,

dash_ai_chatbot-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dash_ai_chatbot-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[dash_hooks]
+dash_ai_chatbot = dash_ai_chatbot._hooks

dash_ai_chatbot-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asyntai
+
+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.

dash_ai_chatbot-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+dash_ai_chatbot