Dash_tooltip 0.5.0__tar.gz

dash_tooltip-0.5.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

dash_tooltip-0.5.0/.github/workflows/Pytest.yml

@@ -0,0 +1,39 @@
+name: Pytest
+
+on:
+  push: {}
+  pull_request: {}
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run Ruff
+        run: uv run ruff check . --output-format=github
+
+      - name: Run Pytest
+        run: uv run pytest tests/ -k "not selenium"

dash_tooltip-0.5.0/.github/workflows/codeql.yml

@@ -0,0 +1,38 @@
+name: CodeQL
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  schedule:
+    - cron: "27 1 * * 4"
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    name: Analyze Python
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: ${{ matrix.language }}
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4
+        with:
+          category: "/language:${{ matrix.language }}"

dash_tooltip-0.5.0/.gitignore

@@ -0,0 +1,154 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+venv/
+ENV/
+venv.bak/
+env*/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+*.ipynb
+
+*.bat

dash_tooltip-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+repos:
+- repo: local
+  hooks:
+    - id: ruff
+      name: ruff
+      description: "Run 'ruff' for extremely fast Python linting"
+      entry: ruff check --fix --force-exclude
+      language: python
+      types_or: [python, pyi]
+      args: []
+      require_serial: true
+      additional_dependencies: []
+      minimum_pre_commit_version: "2.9.2"
+
+    - id: ruff-format
+      name: ruff-format
+      description: "Run 'ruff format' for extremely fast Python formatting"
+      entry: ruff format --force-exclude
+      language: python
+      types_or: [python, pyi]
+      args: []
+      require_serial: true
+      additional_dependencies: []
+      minimum_pre_commit_version: "2.9.2"
+
+#    - id: mypy
+#      name: mypy
+#      description: "Run mypy for static type checking"
+#      entry: mypy
+#      language: system
+#      types: [python]
+
+    - id: pytest-selenium
+      name: pytest (selenium tests)
+      description: "Run pytest for selenium tests"
+      entry: pytest
+      args: ['tests/', '-k', 'selenium', '--webdriver', 'Firefox', '--testmon']
+      language: system
+      pass_filenames: false
+
+    - id: pytest-non-selenium
+      name: pytest (non-selenium tests)
+      description: "Run pytest for non-selenium tests"
+      entry: pytest
+      args: ['tests/', '-k', 'not selenium', '--testmon']
+      language: system
+      pass_filenames: false

dash_tooltip-0.5.0/.python-version

@@ -0,0 +1 @@
+3.14.5

dash_tooltip-0.5.0/Dash_tooltip.egg-info/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: Dash_tooltip
+Version: 0.5.0
+Summary: A tooltip functionality for Dash.
+Author: kb-
+Project-URL: Homepage, https://github.com/kb-/Dash_tooltip
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dash>=2.13.0
+Requires-Dist: plotly>=5.17.0
+Dynamic: license-file
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dash-tooltip)
+[![CodeQL](https://github.com/kb-/Dash_tooltip/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/kb-/Dash_tooltip/actions/workflows/codeql.yml)
+[![Downloads](https://static.pepy.tech/badge/dash_tooltip)](https://pepy.tech/project/dash_tooltip)
+[![Pytest](https://github.com/kb-/Dash_tooltip/actions/workflows/Pytest.yml/badge.svg)](https://github.com/kb-/Dash_tooltip/actions/workflows/Pytest.yml)
+
+# Dash Tooltip
+
+A module to add interactive editable tooltips to your Dash applications. Inspired by `mplcursors` and Matlab's `datatip`.
+
+![newplot(6)](https://github.com/kb-/Dash_tooltip/assets/2260417/0d62008c-25f2-4128-aa31-6746b6b82248)
+
+## Installation
+
+`pip install dash-tooltip`
+
+## Build And Publish
+
+With the current `pyproject.toml`-based setup, use `uv` for local builds and publishing:
+
+```bash
+# Build source distribution and wheel into dist/
+uv build
+
+# Install the built wheel locally
+uv pip install dist/*.whl
+
+# Publish to PyPI
+uv publish
+```
+
+## Basic Usage
+
+```python
+import numpy as np
+import plotly.express as px
+from dash import Dash, dcc, html
+from dash.dependencies import Input, Output
+from dash_tooltip import tooltip
+
+# Sample Data
+np.random.seed(20)
+y1 = np.random.normal(0, 10, 50)
+x1 = np.arange(0, 50)
+fig1 = px.scatter(x=x1, y=y1)
+fig1.update_layout(title_text="Editable Title", title_x=0.5)
+
+app1 = Dash(__name__)
+
+#makes graph items, including tooltips editable
+app1.layout = html.Div([
+    dcc.Graph(
+        id='graph1',
+        figure=fig1,
+        config={
+            'editable': True,
+            'edits': {
+                'shapePosition': True,
+                'annotationPosition': True
+            }
+        }
+    )
+])
+
+# Add the tooltip functionality to the app
+tooltip(app1)
+```
+Click on data points to add tooltips.
+If `dcc.Graph` is configured editatble, tolltips:
+- can be dragged around
+- text can be edited on click
+- can be deleted: click, delete text, enter. In some occasions a tooltip arrow may remain due to a Dash bug (clientside_callback not firing). In this cas, click near arrow end (mouse cursor changes to pointer), enter some text and repeat deletion and enter.
+
+
+## Advanced Usage
+
+If you want to customize the tooltips, hover templates, and more:
+
+```python
+import pandas as pd
+import numpy as np
+import plotly.express as px
+from dash import Dash, dcc, html
+from dash.dependencies import Input, Output
+from dash_tooltip import tooltip
+
+# Generate random time series data
+date_rng = pd.date_range(start='2020-01-01', end='2020-12-31', freq='h')
+ts1 = pd.Series(np.random.randn(len(date_rng)), index=date_rng, name='Time Series 1')
+ts2 = pd.Series(np.random.randn(len(date_rng)), index=date_rng, name='Time Series 2')
+df = pd.DataFrame({ts1.name: ts1, ts2.name: ts2})
+
+# Define the hover and tooltip template
+# name is only compatible with tooltip
+template = "name:%{name}<br>META0: %{meta[0]}<br>META1: %{meta[1]}<br>x: %{x}<br>y: %{y:.2f}<br>pointNumber: %{pointNumber}<br>customdata0: %{customdata[0]}<br>customdata1: %{customdata[1]}"
+
+# Create a line plot
+fig10 = px.line(df, x=df.index, y=df.columns, title="Time Series Plot")
+
+# Apply metadata and custom data to each trace
+for i, trace in enumerate(fig10.data):
+    # Applying different metadata to each trace
+    trace.meta = [f"META{i}0", f"META{i}1"]
+    
+    # Setting customdata for each point in the trace, for use in the hover template
+    trace.customdata = np.array([[f"Series {i+1}", f'Point {j+1}'] for j in range(len(df))])
+    
+    # Setting the hover template
+    trace.hovertemplate = template
+
+app10 = Dash(__name__)
+
+app10.layout = html.Div([
+    dcc.Graph(
+        id="graph-id",
+        figure=fig10,
+        config={
+            'editable': True,
+            'edits': {
+                'shapePosition': True,
+                'annotationPosition': True
+            }
+        }
+    )
+])
+
+tooltip(app10, graph_ids=["graph-id"], template=template, debug=True)
+app10.run(port=8082)
+```
+
+## Tooltip Templates with Formatting
+
+Tooltips can be formatted using templates similar to Plotly's hovertemplates. The tooltip template allows custom formatting and the inclusion of text and values.
+
+For example, you can use a template like `"%{name}<br>%{meta[0]}<br>x: %{x:.2f}<br>y: %{y:.2f}"` to display the track `name`, `meta[0]` from a list of text data, plus `x` and `y` values with two decimal places. Note that `name` key is not available in the Plotly hover template, but is displayed by default.
+
+Refer to [Plotly’s documentation on hover text and formatting](https://plotly.com/python/hover-text-and-formatting/) for more details on how to construct and customize your tooltip templates.
+
+## Custom Styling
+
+```python
+custom_style = {
+        "font": {"size": 12, "color":"red"},
+        "arrowcolor": "red",
+        'arrowsize': 5,
+        # ... any other customization
+    }
+tooltip(app10, style=custom_style, graph_ids=["graph-id"], template=template, debug=True)
+```
+
+For more examples, refer to the provided `dash_tooltip_demo.py` and check out [Plotly’s Text and Annotations documentation](https://plotly.com/python/text-and-annotations/#styling-and-coloring-annotations), which provides a wealth of information on customizing the appearance of annotations.
+Refer to the [Plotly Annotation Reference](https://plotly.com/python/reference/layout/annotations/) for a comprehensive guide on available styling attributes and how to apply them.
+
+## Template updating
+
+Tooltip content can be updated to match with selected data in a dynamic Dash app:
+```python
+GRAPH_ID = "scatter-plot16a"
+
+# Sample DataFrame with DatetimeIndex
+date_range = pd.date_range(start="2025-01-01", periods=5)
+df = pd.DataFrame(
+    {
+        "x": [1, 2, 3, 4, 5],
+        "y": [2, 4, 6, 8, 10],
+        "z": [3, 6, 9, 12, 15],
+        "a": [4, 8, 12, 16, 20],
+        "b": [5, 10, 15, 20, 25],
+    },
+    index=date_range,
+)
+
+# Initialize the Dash app
+app16 = dash.Dash(__name__)
+
+# Define the layout
+app16.layout = html.Div(
+    [
+        html.Label("Select X and Y columns:"),
+        dcc.Dropdown(
+            id="x-column",
+            options=[{"label": col, "value": col} for col in df.columns],
+            placeholder="Select X axis data",
+        ),
+        dcc.Dropdown(
+            id="y-column",
+            options=[{"label": col, "value": col} for col in df.columns],
+            placeholder="Select Y axis data",
+        ),
+        dcc.Graph(
+            id=GRAPH_ID,
+            style={"width": "600px", "height": "600px"},
+            config={
+                "editable": True,
+                "edits": {"shapePosition": True, "annotationPosition": True},
+            },
+        ),
+    ]
+)
+
+# Create a tooltip instance
+tooltip_instance16 = tooltip(app16, graph_ids=[GRAPH_ID])
+
+# Define callback to update the scatter plot
+@app16.callback(
+    Output(GRAPH_ID, "figure", allow_duplicate=True),
+    [Input("x-column", "value"), Input("y-column", "value")],
+    prevent_initial_call=True,
+)
+def update_scatter_plot(x_column, y_column):
+    if not x_column or not y_column:
+        raise PreventUpdate  # Prevent update if either dropdown is not selected
+
+    non_selected_columns = [
+        col for col in df.columns if col not in [x_column, y_column]
+    ]
+    customdata = df[non_selected_columns].apply(
+        lambda row: "<br>".join(
+            f"{col}: {val}" for col, val in zip(non_selected_columns, row)
+        ),
+        axis=1,
+    )
+    # gives (depending on selected entries):
+    # 2022-01-01     x: 1<br>z: 3<br>b: 5
+    # 2022-01-02     x: 2<br>z: 6<br>b: 10
+    # ...
+
+    # New template, to match selected data entries
+    template = (
+        "<b>Date</b>: %{customdata}<br>"
+        + f"<b>{x_column}: %{{x}}<br>"
+        + f"{y_column}: %{{y}}</b><br>"
+    )
+    # gives (depending on selected entries):
+    # <b>Date</b>: %{customdata}<br><b>x: %{x}<br><b>a</b>: %{y}<br>
+
+    # Update template for new tooltips
+    tooltip_instance16.update_template(graph_id=GRAPH_ID, template=template)
+
+    trace = go.Scatter(
+        x=df[x_column],
+        y=df[y_column],
+        mode="markers",
+        marker=dict(color="blue"),
+        customdata=df.index.strftime("%Y-%m-%d %H:%M:%S") + "<br>" + customdata,
+        # Include date and time with other data
+        hovertemplate=template,
+    )
+    layout = go.Layout(
+        title="Scatter Plot",
+        xaxis=dict(title=x_column),
+        yaxis=dict(title=y_column),
+        hovermode="closest",
+        height=800,
+        width=800,
+    )
+    return {"data": [trace], "layout": layout}
+
+
+# Run the app
+if __name__ == "__main__":
+app16.run(debug=False, port=8196)
+```
+
+## Handling Log Axes
+
+Due to a long-standing bug in Plotly (see [Plotly Issue #2580](https://github.com/plotly/plotly.py/issues/2580)), annotations (`fig.add_annotation`) may not be placed correctly on log-scaled axes. The `dash_tooltip` module provides an option to automatically correct the tooltip placement on log-scaled axes via the `apply_log_fix` argument in the `tooltip` function. By default, `apply_log_fix` is set to `True` to enable the fix.
+
+## Debugging
+
+If you encounter any issues or unexpected behaviors, enable the debug mode by setting the `debug` argument of the `tooltip` function to `True`. The log outputs will be written to `dash_app.log` in the directory where your script or application is located.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+- Inspired by `mplcursors` and Matlab's `datatip`.

dash_tooltip-0.5.0/Dash_tooltip.egg-info/SOURCES.txt

@@ -0,0 +1,39 @@
+.gitattributes
+.gitignore
+.pre-commit-config.yaml
+.python-version
+LICENSE
+README.md
+dash_qt_demo.py
+dash_qt_demo2.py
+dash_tooltip_demo.py
+pyproject.toml
+uv.lock
+.github/workflows/Pytest.yml
+.github/workflows/codeql.yml
+Dash_tooltip.egg-info/PKG-INFO
+Dash_tooltip.egg-info/SOURCES.txt
+Dash_tooltip.egg-info/dependency_links.txt
+Dash_tooltip.egg-info/requires.txt
+Dash_tooltip.egg-info/top_level.txt
+dash_tooltip/__init__.py
+dash_tooltip/_version.py
+dash_tooltip/config.py
+dash_tooltip/custom_figure.py
+dash_tooltip/utils.py
+tests/__init__.py
+tests/test_11_direct_figure_in_dcc_graph.py
+tests/test_12_go_scatter.py
+tests/test_13_go_scatter_line.py
+tests/test_14_go_bar_chart.py
+tests/test_16_update_template.py
+tests/test_17_annotation_relayout_persistence.py
+tests/test_1_tooltip_function.py
+tests/test_2_tooltip_configuration.py
+tests/test_3_template_formating.py
+tests/test_4a_multiple_graph.py
+tests/test_4b_multiple_graph.py
+tests/test_6_invalid_graph_id.py
+tests/test_7_tooltip_removal.py
+tests/test_8__display_click_data.py
+tests/test_dummy.py

dash_tooltip-0.5.0/Dash_tooltip.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dash_tooltip-0.5.0/Dash_tooltip.egg-info/requires.txt

@@ -0,0 +1,2 @@
+dash>=2.13.0
+plotly>=5.17.0

dash_tooltip-0.5.0/Dash_tooltip.egg-info/top_level.txt

@@ -0,0 +1 @@
+dash_tooltip

dash_tooltip-0.5.0/LICENSE

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