ipyprogressivis 0.3.0__tar.gz

ipyprogressivis-0.3.0/.gitignore

@@ -0,0 +1,15 @@
+*~
+*#
+*.egg-info/
+.ipynb_checkpoints/
+ipyprogressivis/_version.py
+dist/
+build/
+*.py[cod]
+node_modules/
+
+# Compiled javascript
+nbwidgets/static/
+
+# OS X
+.DS_Store

ipyprogressivis-0.3.0/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2017, Jean-Daniel Fekete
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

ipyprogressivis-0.3.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: ipyprogressivis
+Version: 0.3.0
+Summary: A Custom Jupyter Widget Library for Progressivis
+Project-URL: Homepage, https://github.com/progressivis/ipyprogressivis
+Author-email: "INRIA, Jean-Daniel Fekete, Christian Poli" <jean-daniel.fekete@inria.fr>
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+Keywords: IPython,Jupyter,Widgets
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+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
+Requires-Python: >=3.10
+Requires-Dist: ipydatawidgets
+Requires-Dist: ipywidgets<9,>=7.6
+Requires-Dist: jupyter-client>=8.6.0
+Requires-Dist: lz4
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pandas<3.0.0,>=1.0.0
+Requires-Dist: pillow
+Requires-Dist: sidecar>=0.7.0
+Requires-Dist: traitlets>=4.3.0
+Requires-Dist: traittypes>=0.0.6
+Requires-Dist: vega>=4.0.0
+Provides-Extra: dev
+Requires-Dist: jupyterlab>=4.0.0; extra == 'dev'
+Provides-Extra: progressivis
+Requires-Dist: progressivis; extra == 'progressivis'
+Provides-Extra: test
+Requires-Dist: nbval; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=6.0; extra == 'test'
+Provides-Extra: typing
+Requires-Dist: duckdb; extra == 'typing'
+Requires-Dist: ipython; extra == 'typing'
+Requires-Dist: jinja2; extra == 'typing'
+Requires-Dist: mypy>=1.0.1; extra == 'typing'
+Requires-Dist: numpy; extra == 'typing'
+Requires-Dist: pandas-stubs; extra == 'typing'
+Requires-Dist: sqlalchemy-stubs; extra == 'typing'
+Requires-Dist: traits-stubs; extra == 'typing'
+Requires-Dist: traittypes; extra == 'typing'
+Requires-Dist: typeguard; extra == 'typing'
+Requires-Dist: types-pillow; extra == 'typing'
+Requires-Dist: types-pytz; extra == 'typing'
+Requires-Dist: types-pyyaml; extra == 'typing'
+Requires-Dist: types-requests; extra == 'typing'
+Requires-Dist: types-setuptools; extra == 'typing'
+Requires-Dist: types-urllib3; extra == 'typing'
+Requires-Dist: typing-extensions; extra == 'typing'
+Description-Content-Type: text/markdown
+
+# IpyProgressiVis: A Custom Jupyter Widget Library for ProgressiVis
+
+[![Python Tests](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml/badge.svg?branch=main&event=push)](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml)
+[![Documentation Status](https://readthedocs.org/projects/progressivis/badge/?version=latest)](https://progressivis.readthedocs.io/en/latest/?badge=latest)
+[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+[![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
+
+
+## Installation
+
+See the installation instructions [provided here](https://progressivis.readthedocs.io/en/latest/install.html).
+
+## Running demos (on your computer)
+
+After installing `ipyprogressivis` do:
+
+```
+cd ipyprogressivis/notebooks
+jupyter lab
+```
+then run the notebooks of your choice
+
+<!--
+### Running under Voilà
+
+Install voilà :
+
+$ conda install -c conda-forge voila
+
+#### As a standalone app :
+
+voila --enable_nbextensions=True YourNotebook.ipynb
+
+#### As a server extension to notebook or jupyter_server
+
+First, you have to enable the extension:
+
+$ jupyter serverextension enable voila --sys-prefix
+
+
+Then run:
+
+$jupyter lab --VoilaConfiguration.enable_nbextensions=True
+
+or
+
+$jupyter notebook --VoilaConfiguration.enable_nbextensions=True
+
+When running the Jupyter server, the Voilà app is accessible from the base url suffixed with voila
+
+#### Using a JupyterLab extension to render a notebook with voila
+
+Install the extension :
+
+jupyter labextension install @jupyter-voila/jupyterlab-preview
+
+Display the notebook with Voilà like showed here: https://user-images.githubusercontent.com/591645/59288034-1f8d6a80-8c73-11e9-860f-c3449dd3dcb5.gif
+-->

ipyprogressivis-0.3.0/README.md

@@ -0,0 +1,60 @@
+# IpyProgressiVis: A Custom Jupyter Widget Library for ProgressiVis
+
+[![Python Tests](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml/badge.svg?branch=main&event=push)](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml)
+[![Documentation Status](https://readthedocs.org/projects/progressivis/badge/?version=latest)](https://progressivis.readthedocs.io/en/latest/?badge=latest)
+[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+[![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
+
+
+## Installation
+
+See the installation instructions [provided here](https://progressivis.readthedocs.io/en/latest/install.html).
+
+## Running demos (on your computer)
+
+After installing `ipyprogressivis` do:
+
+```
+cd ipyprogressivis/notebooks
+jupyter lab
+```
+then run the notebooks of your choice
+
+<!--
+### Running under Voilà
+
+Install voilà :
+
+$ conda install -c conda-forge voila
+
+#### As a standalone app :
+
+voila --enable_nbextensions=True YourNotebook.ipynb
+
+#### As a server extension to notebook or jupyter_server
+
+First, you have to enable the extension:
+
+$ jupyter serverextension enable voila --sys-prefix
+
+
+Then run:
+
+$jupyter lab --VoilaConfiguration.enable_nbextensions=True
+
+or
+
+$jupyter notebook --VoilaConfiguration.enable_nbextensions=True
+
+When running the Jupyter server, the Voilà app is accessible from the base url suffixed with voila
+
+#### Using a JupyterLab extension to render a notebook with voila
+
+Install the extension :
+
+jupyter labextension install @jupyter-voila/jupyterlab-preview
+
+Display the notebook with Voilà like showed here: https://user-images.githubusercontent.com/591645/59288034-1f8d6a80-8c73-11e9-860f-c3449dd3dcb5.gif
+-->

ipyprogressivis-0.3.0/ipyprogressivis/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include widgets/static *.*
+include progressivis-nb-widgets.json

ipyprogressivis-0.3.0/ipyprogressivis/__init__.py

@@ -0,0 +1,90 @@
+# type: ignore
+from ._version import __version__
+import asyncio
+
+_ = __version__
+
+
+def _jupyter_labextension_paths():
+    """Called by Jupyter Lab Server to detect if it is a valid labextension and
+    to install the widget
+
+    Returns
+    =======
+    src: Source directory name to copy files from. Webpack outputs generated files
+        into this directory and Jupyter Lab copies from this directory during
+        widget installation
+    dest: Destination directory name to install widget files to. Jupyter Lab copies
+        from `src` directory into <jupyter path>/labextensions/<dest> directory
+        during widget installation
+    """
+    return [{
+        'src': 'labextension',
+        'dest': 'jupyter-progressivis',
+    }]
+
+
+def _jupyter_nbextension_paths():
+    """Called by Jupyter Notebook Server to detect if it is a valid nbextension and
+    to install the widget
+
+    Returns
+    =======
+    section: The section of the Jupyter Notebook Server to change.
+        Must be 'notebook' for widget extensions
+    src: Source directory name to copy files from. Webpack outputs generated files
+        into this directory and Jupyter Notebook copies from this directory during
+        widget installation
+    dest: Destination directory name to install widget files to. Jupyter Notebook copies
+        from `src` directory into <jupyter path>/nbextensions/<dest> directory
+        during widget installation
+    require: Path to importable AMD Javascript module inside the
+        <jupyter path>/nbextensions/<dest> directory
+    """
+    return [{
+        'section': 'notebook',
+        'src': 'nbextension',
+        'dest': 'jupyter-progressivis',
+        'require': 'jupyter-progressivis/extension'
+    }]
+
+
+def _jupyter_server_extension_points():
+    """
+    Returns a list of dictionaries with metadata describing
+    where to find the `_load_jupyter_server_extension` function.
+    """
+    return [{"module": "ipyprogressivis.app"}]
+
+
+def pre_save(model, contents_manager,  **kwargs):
+    from .pre_save_md import pre_save_md_impl
+    from .pre_save import pre_save_impl
+    log = contents_manager.log
+    log.info("Starting pre_save ...")
+    pre_save_md_impl(model, contents_manager, **kwargs)
+    pre_save_impl(model, contents_manager, **kwargs)
+    log.info("... end pre_save")
+
+
+def pre_save_x(model, contents_manager,  **kwargs):
+    import nest_asyncio
+    nest_asyncio.apply()
+    from .pre_save_md import pre_save_md_impl
+    from .pre_save_x import pre_save_impl
+    log = contents_manager.log
+    log.info("Starting pre_save_x ...")
+    pre_save_md_impl(model, contents_manager, **kwargs)
+    loop = asyncio.get_event_loop()
+    task = loop.create_task(pre_save_impl(model, contents_manager, **kwargs))
+    loop.run_until_complete(task)
+    log.info("... end pre_save_x")
+
+def pre_save_md(model, contents_manager,  **kwargs):
+    from .pre_save_md import pre_save_md_impl
+    log = contents_manager.log
+    log.info("Starting pre_save_md ...")
+    pre_save_md_impl(model, contents_manager, **kwargs)
+    log.info("... end pre_save_md")
+
+__all__ = ["__version__"]

ipyprogressivis-0.3.0/ipyprogressivis/_frontend.py

@@ -0,0 +1,5 @@
+# Module version
+
+
+NPM_PACKAGE = "jupyter-progressivis"
+NPM_PACKAGE_RANGE = "^0.1.0"

ipyprogressivis-0.3.0/ipyprogressivis/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)

ipyprogressivis-0.3.0/ipyprogressivis/app.py

@@ -0,0 +1,26 @@
+# type: ignore
+from jupyter_server.base.handlers import JupyterHandler
+from jupyter_server.serverapp import ServerApp
+import tornado
+import json
+from os.path import join as pjoin
+
+
+class ProgressivisHandler(JupyterHandler):
+    @tornado.web.authenticated
+    def get(self) -> None:
+        import ipyprogressivis
+        nb_name = pjoin(ipyprogressivis.__path__[0],
+                        "notebook_templates",
+                        "ProgressiBook.ipynb")
+        with open(nb_name) as fd:
+            payload = fd.read()
+            self.finish(json.dumps(dict(payload=payload)))
+
+
+def _load_jupyter_server_extension(serverapp: ServerApp) -> None:
+    """
+    This function is called when the extension is loaded.
+    """
+    handlers = [("/progressivis/template", ProgressivisHandler)]
+    serverapp.web_app.add_handlers(".*$", handlers)  # type: ignore

ipyprogressivis-0.3.0/ipyprogressivis/hook_tools.py

@@ -0,0 +1,40 @@
+from PIL import Image
+import base64
+import io
+import os
+from pathlib import Path
+
+from typing import Any
+
+eye_img = Image.open(Path(os.path.dirname(__file__)) / "resources" / "snapshot_marker.png")
+eye_img = eye_img.resize((64, 64))
+
+
+def add_snapshot_tag(data: Any) -> str:
+    img = Image.open(io.BytesIO(base64.b64decode(data)))
+    # img = img.filter(ImageFilter.BLUR)
+    img.paste(eye_img, (0, 0), eye_img)
+    buffered = io.BytesIO()
+    img.save(buffered, format="PNG")
+    return base64.b64encode(buffered.getvalue()).decode("utf-8")
+
+def add_snapshot_tag_from_bytes(data: Any) -> str:
+    img = Image.open(io.BytesIO(data))
+    # img = img.filter(ImageFilter.BLUR)
+    img.paste(eye_img, (0, 0), eye_img)
+    buffered = io.BytesIO()
+    img.save(buffered, format="PNG")
+    return base64.b64encode(buffered.getvalue()).decode("utf-8")
+
+def parse_tag(tag: str) -> tuple[str, int]:
+    if "[" not in tag:
+        return tag, 0
+    assert tag[-1] == "]"
+    pos = tag.index("[")
+    return tag[:pos], int(tag[pos+1:-1])
+
+
+def make_css_marker(key: str, nb: int = 0) -> str:
+    key = key.replace(" ", "_")
+    return f"progressivis_guest_widget--{key}_{nb}"
+

ipyprogressivis-0.3.0/ipyprogressivis/install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "ipyprogressivis",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package ipyprogressivis"
+}

ipyprogressivis-0.3.0/ipyprogressivis/js/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

ipyprogressivis-0.3.0/ipyprogressivis/js/.eslintrc.js

@@ -0,0 +1,32 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "globals": {
+        "__webpack_public_path__": "writable",
+        "sorttable": "readable"
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:react/recommended"
+    ],
+    "settings": {
+        "react": {
+            "version": "detect"
+        }
+    },
+    "parserOptions": {
+        "ecmaFeatures": {
+            "jsx": true
+        },
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "react"
+    ],
+    "rules": {
+    }
+};

ipyprogressivis-0.3.0/ipyprogressivis/js/README.md

@@ -0,0 +1,11 @@
+A Custom Jupyter Widget Library for Progressivis
+
+Package Install
+---------------
+
+**Prerequisites**
+- [node](http://nodejs.org/)
+
+```bash
+npm install --save progressivis-nb-widgets
+```