neo4j-viz 0.2.6__tar.gz → 0.3.0__tar.gz

{neo4j_viz-0.2.6 → neo4j_viz-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neo4j-viz
-Version: 0.2.6
+Version: 0.3.0
 Summary: A simple graph visualization tool
 Author-email: Neo4j <team-gds@neo4j.org>
 Project-URL: Homepage, https://neo4j.com/
@@ -33,15 +33,16 @@ Requires-Dist: pydantic<3,>=2
 Requires-Dist: pydantic-extra-types<3,>=2
 Requires-Dist: enum-tools==0.12.0
 Provides-Extra: dev
-Requires-Dist: ruff==0.9.7; extra == "dev"
+Requires-Dist: ruff==0.11.8; extra == "dev"
 Requires-Dist: mypy==1.15.0; extra == "dev"
 Requires-Dist: pytest==8.3.4; extra == "dev"
-Requires-Dist: selenium==4.28.1; extra == "dev"
+Requires-Dist: selenium==4.32.0; extra == "dev"
 Requires-Dist: ipykernel==6.29.5; extra == "dev"
 Requires-Dist: palettable==3.3.3; extra == "dev"
 Requires-Dist: pytest-mock==3.14.0; extra == "dev"
 Requires-Dist: nbconvert==7.16.6; extra == "dev"
-Requires-Dist: streamlit==1.42.0; extra == "dev"
+Requires-Dist: streamlit==1.45.0; extra == "dev"
+Requires-Dist: matplotlib>=3.9.4; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx==8.1.3; extra == "docs"
 Requires-Dist: enum-tools[sphinx]; extra == "docs"
@@ -55,12 +56,12 @@ Requires-Dist: graphdatascience<2,>=1; extra == "gds"
 Provides-Extra: neo4j
 Requires-Dist: neo4j; extra == "neo4j"
 Provides-Extra: notebook
-Requires-Dist: ipykernel==6.29.5; extra == "notebook"
-Requires-Dist: pykernel==0.1.6; extra == "notebook"
+Requires-Dist: ipykernel>=6.29.5; extra == "notebook"
+Requires-Dist: pykernel>=0.1.6; extra == "notebook"
 Requires-Dist: neo4j>=5.26.0; extra == "notebook"
 Requires-Dist: ipywidgets>=8.0.0; extra == "notebook"
-Requires-Dist: palettable==3.3.3; extra == "notebook"
-Requires-Dist: matplotlib==3.10.0; extra == "notebook"
+Requires-Dist: palettable>=3.3.3; extra == "notebook"
+Requires-Dist: matplotlib>=3.9.4; extra == "notebook"
 Requires-Dist: snowflake-snowpark-python==1.26.0; extra == "notebook"
 
 # Graph Visualization for Python by Neo4j
@@ -73,9 +74,9 @@ Requires-Dist: snowflake-snowpark-python==1.26.0; extra == "notebook"
 [![Community forum](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=Forums&logo=discourse&up_color=green&up_message=online&url=https%3A%2F%2Fcommunity.neo4j.com%2F)](https://community.neo4j.com)
 [![License](https://img.shields.io/pypi/l/neo4j-viz)](https://pypi.org/project/neo4j-viz/)
 
-`neo4j-viz` is a Python package for creating interactive graph visualizations based on data from Neo4j products.
+`neo4j-viz` is a Python package for creating interactive graph visualizations.
 
-The output is of type `IPython.display.HTML` and can be viewed directly in a Jupyter Notebook, Streamlit.
+The output is of type `IPython.display.HTML` and can be viewed directly in a Jupyter Notebook or Streamlit application.
 Alternatively, you can export the output to a file and view it in a web browser.
 
 The package wraps the [Neo4j Visualization JavaScript library (NVL)](https://neo4j.com/docs/nvl/current/).
@@ -98,9 +99,11 @@ The package wraps the [Neo4j Visualization JavaScript library (NVL)](https://neo
   * Colors
   * Captions
   * Pinning
+  * On hover tooltip
 * Relationship features:
   * Colors
   * Captions
+  * On hover tooltip
 * Graph features:
   * Zooming
   * Panning

{neo4j_viz-0.2.6 → neo4j_viz-0.3.0}/README.md

@@ -8,9 +8,9 @@
 [![Community forum](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=Forums&logo=discourse&up_color=green&up_message=online&url=https%3A%2F%2Fcommunity.neo4j.com%2F)](https://community.neo4j.com)
 [![License](https://img.shields.io/pypi/l/neo4j-viz)](https://pypi.org/project/neo4j-viz/)
 
-`neo4j-viz` is a Python package for creating interactive graph visualizations based on data from Neo4j products.
+`neo4j-viz` is a Python package for creating interactive graph visualizations.
 
-The output is of type `IPython.display.HTML` and can be viewed directly in a Jupyter Notebook, Streamlit.
+The output is of type `IPython.display.HTML` and can be viewed directly in a Jupyter Notebook or Streamlit application.
 Alternatively, you can export the output to a file and view it in a web browser.
 
 The package wraps the [Neo4j Visualization JavaScript library (NVL)](https://neo4j.com/docs/nvl/current/).
@@ -33,9 +33,11 @@ The package wraps the [Neo4j Visualization JavaScript library (NVL)](https://neo
   * Colors
   * Captions
   * Pinning
+  * On hover tooltip
 * Relationship features:
   * Colors
   * Captions
+  * On hover tooltip
 * Graph features:
   * Zooming
   * Panning

{neo4j_viz-0.2.6 → neo4j_viz-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "neo4j-viz"
-version = "0.2.6"
+version = "0.3.0"
 description = "A simple graph visualization tool"
 readme = "README.md"
 authors = [{ name = "Neo4j", email = "team-gds@neo4j.org" }]
@@ -41,15 +41,16 @@ requires-python = ">=3.9"
 
 [project.optional-dependencies]
 dev = [
-    "ruff==0.9.7",
+    "ruff==0.11.8",
     "mypy==1.15.0",
     "pytest==8.3.4",
-    "selenium==4.28.1",
+    "selenium==4.32.0",
     "ipykernel==6.29.5",
     "palettable==3.3.3",
     "pytest-mock==3.14.0",
     "nbconvert==7.16.6",
-    "streamlit==1.42.0",
+    "streamlit==1.45.0",
+    "matplotlib>=3.9.4",
 ]
 docs = [
     "sphinx==8.1.3",
@@ -61,12 +62,12 @@ pandas = ["pandas>=2, <3", "pandas-stubs>=2, <3"]
 gds = ["graphdatascience>=1, <2"]
 neo4j = ["neo4j"]
 notebook = [
-    "ipykernel==6.29.5",
-    "pykernel==0.1.6",
+    "ipykernel>=6.29.5",
+    "pykernel>=0.1.6",
     "neo4j>=5.26.0",
     "ipywidgets>=8.0.0",
-    "palettable==3.3.3",
-    "matplotlib==3.10.0",
+    "palettable>=3.3.3",
+    "matplotlib>=3.9.4",
     "snowflake-snowpark-python==1.26.0",
 ]
 
@@ -87,7 +88,12 @@ include = [
 namespaces = false # only scan directories with __init__.py files (true by default)
 
 [tool.setuptools.package-data]
-neo4j_viz = ["resources/nvl_entrypoint/base.js", "py.typed"]
+neo4j_viz = [
+    "resources/nvl_entrypoint/base.js",
+    "resources/nvl_entrypoint/styles.css",
+    "resources/icons/*.svg",
+    "py.typed"
+]
 
 [tool.pytest.ini_options]
 addopts = ["--import-mode=importlib"]

neo4j_viz-0.3.0/src/neo4j_viz/colors.py

@@ -0,0 +1,303 @@
+from collections.abc import Iterable
+from enum import Enum
+from typing import Any, Union
+
+import enum_tools
+from pydantic_extra_types.color import ColorType
+
+ColorsType = Union[dict[Any, ColorType], Iterable[ColorType]]
+
+
+@enum_tools.documentation.document_enum
+class ColorSpace(Enum):
+    """
+    Describes the type of color space used by a color palette.
+    """
+
+    DISCRETE = "discrete"
+    """
+    This category describes a color palette that is a collection of different colors that are not necessarily related to
+    each other. Discrete color spaces are suitable for categorical data, where each unique category is represented by a
+    different color.
+    """
+    CONTINUOUS = "continuous"
+    """
+    This category describes a color palette that is a range/gradient of colors between two or more colors. Continuous
+    color spaces are suitable for continuous data (typically floats), where values can change smoothly.
+    """
+
+
+# Comes from https://neo4j.design/40a8cff71/p/5639c0-color/t/page-5639c0-79109681-33
+NEO4J_COLORS_DISCRETE = [
+    "#FFDF81",
+    "#C990C0",
+    "#F79767",
+    "#56C7E4",
+    "#F16767",
+    "#D8C7AE",
+    "#8DCC93",
+    "#ECB4C9",
+    "#4D8DDA",
+    "#FFC354",
+    "#DA7294",
+    "#579380",
+]
+_NEO4J_COLORS_CONTINUOUS_BASE = ["#FFDF81", "#C990C0"]
+NEO4J_COLORS_CONTINUOUS = [
+    (255, 223, 129),
+    (255, 223, 129),
+    (255, 222, 129),
+    (254, 222, 130),
+    (254, 222, 130),
+    (254, 221, 130),
+    (254, 221, 130),
+    (254, 221, 131),
+    (253, 221, 131),
+    (253, 220, 131),
+    (253, 220, 131),
+    (253, 220, 132),
+    (252, 219, 132),
+    (252, 219, 132),
+    (252, 219, 132),
+    (252, 218, 133),
+    (252, 218, 133),
+    (251, 218, 133),
+    (251, 217, 133),
+    (251, 217, 134),
+    (251, 217, 134),
+    (251, 216, 134),
+    (250, 216, 134),
+    (250, 216, 135),
+    (250, 216, 135),
+    (250, 215, 135),
+    (249, 215, 135),
+    (249, 215, 136),
+    (249, 214, 136),
+    (249, 214, 136),
+    (249, 214, 136),
+    (248, 213, 137),
+    (248, 213, 137),
+    (248, 213, 137),
+    (248, 212, 137),
+    (248, 212, 138),
+    (247, 212, 138),
+    (247, 212, 138),
+    (247, 211, 138),
+    (247, 211, 139),
+    (247, 211, 139),
+    (246, 210, 139),
+    (246, 210, 139),
+    (246, 210, 140),
+    (246, 209, 140),
+    (245, 209, 140),
+    (245, 209, 140),
+    (245, 208, 141),
+    (245, 208, 141),
+    (245, 208, 141),
+    (244, 208, 141),
+    (244, 207, 142),
+    (244, 207, 142),
+    (244, 207, 142),
+    (244, 206, 142),
+    (243, 206, 143),
+    (243, 206, 143),
+    (243, 205, 143),
+    (243, 205, 143),
+    (243, 205, 144),
+    (242, 204, 144),
+    (242, 204, 144),
+    (242, 204, 144),
+    (242, 203, 145),
+    (241, 203, 145),
+    (241, 203, 145),
+    (241, 203, 145),
+    (241, 202, 146),
+    (241, 202, 146),
+    (240, 202, 146),
+    (240, 201, 146),
+    (240, 201, 147),
+    (240, 201, 147),
+    (240, 200, 147),
+    (239, 200, 147),
+    (239, 200, 148),
+    (239, 199, 148),
+    (239, 199, 148),
+    (238, 199, 148),
+    (238, 199, 149),
+    (238, 198, 149),
+    (238, 198, 149),
+    (238, 198, 149),
+    (237, 197, 150),
+    (237, 197, 150),
+    (237, 197, 150),
+    (237, 196, 150),
+    (237, 196, 150),
+    (236, 196, 151),
+    (236, 195, 151),
+    (236, 195, 151),
+    (236, 195, 151),
+    (236, 194, 152),
+    (235, 194, 152),
+    (235, 194, 152),
+    (235, 194, 152),
+    (235, 193, 153),
+    (234, 193, 153),
+    (234, 193, 153),
+    (234, 192, 153),
+    (234, 192, 154),
+    (234, 192, 154),
+    (233, 191, 154),
+    (233, 191, 154),
+    (233, 191, 155),
+    (233, 190, 155),
+    (233, 190, 155),
+    (232, 190, 155),
+    (232, 190, 156),
+    (232, 189, 156),
+    (232, 189, 156),
+    (231, 189, 156),
+    (231, 188, 157),
+    (231, 188, 157),
+    (231, 188, 157),
+    (231, 187, 157),
+    (230, 187, 158),
+    (230, 187, 158),
+    (230, 186, 158),
+    (230, 186, 158),
+    (230, 186, 159),
+    (229, 186, 159),
+    (229, 185, 159),
+    (229, 185, 159),
+    (229, 185, 160),
+    (229, 184, 160),
+    (228, 184, 160),
+    (228, 184, 160),
+    (228, 183, 161),
+    (228, 183, 161),
+    (227, 183, 161),
+    (227, 182, 161),
+    (227, 182, 162),
+    (227, 182, 162),
+    (227, 181, 162),
+    (226, 181, 162),
+    (226, 181, 163),
+    (226, 181, 163),
+    (226, 180, 163),
+    (226, 180, 163),
+    (225, 180, 164),
+    (225, 179, 164),
+    (225, 179, 164),
+    (225, 179, 164),
+    (225, 178, 165),
+    (224, 178, 165),
+    (224, 178, 165),
+    (224, 177, 165),
+    (224, 177, 166),
+    (223, 177, 166),
+    (223, 177, 166),
+    (223, 176, 166),
+    (223, 176, 167),
+    (223, 176, 167),
+    (222, 175, 167),
+    (222, 175, 167),
+    (222, 175, 168),
+    (222, 174, 168),
+    (222, 174, 168),
+    (221, 174, 168),
+    (221, 173, 169),
+    (221, 173, 169),
+    (221, 173, 169),
+    (220, 173, 169),
+    (220, 172, 170),
+    (220, 172, 170),
+    (220, 172, 170),
+    (220, 171, 170),
+    (219, 171, 171),
+    (219, 171, 171),
+    (219, 170, 171),
+    (219, 170, 171),
+    (219, 170, 171),
+    (218, 169, 172),
+    (218, 169, 172),
+    (218, 169, 172),
+    (218, 168, 172),
+    (218, 168, 173),
+    (217, 168, 173),
+    (217, 168, 173),
+    (217, 167, 173),
+    (217, 167, 174),
+    (216, 167, 174),
+    (216, 166, 174),
+    (216, 166, 174),
+    (216, 166, 175),
+    (216, 165, 175),
+    (215, 165, 175),
+    (215, 165, 175),
+    (215, 164, 176),
+    (215, 164, 176),
+    (215, 164, 176),
+    (214, 164, 176),
+    (214, 163, 177),
+    (214, 163, 177),
+    (214, 163, 177),
+    (213, 162, 177),
+    (213, 162, 178),
+    (213, 162, 178),
+    (213, 161, 178),
+    (213, 161, 178),
+    (212, 161, 179),
+    (212, 160, 179),
+    (212, 160, 179),
+    (212, 160, 179),
+    (212, 159, 180),
+    (211, 159, 180),
+    (211, 159, 180),
+    (211, 159, 180),
+    (211, 158, 181),
+    (211, 158, 181),
+    (210, 158, 181),
+    (210, 157, 181),
+    (210, 157, 182),
+    (210, 157, 182),
+    (209, 156, 182),
+    (209, 156, 182),
+    (209, 156, 183),
+    (209, 155, 183),
+    (209, 155, 183),
+    (208, 155, 183),
+    (208, 155, 184),
+    (208, 154, 184),
+    (208, 154, 184),
+    (208, 154, 184),
+    (207, 153, 185),
+    (207, 153, 185),
+    (207, 153, 185),
+    (207, 152, 185),
+    (207, 152, 186),
+    (206, 152, 186),
+    (206, 151, 186),
+    (206, 151, 186),
+    (206, 151, 187),
+    (205, 151, 187),
+    (205, 150, 187),
+    (205, 150, 187),
+    (205, 150, 188),
+    (205, 149, 188),
+    (204, 149, 188),
+    (204, 149, 188),
+    (204, 148, 189),
+    (204, 148, 189),
+    (204, 148, 189),
+    (203, 147, 189),
+    (203, 147, 190),
+    (203, 147, 190),
+    (203, 146, 190),
+    (202, 146, 190),
+    (202, 146, 191),
+    (202, 146, 191),
+    (202, 145, 191),
+    (202, 145, 191),
+    (201, 145, 192),
+    (201, 144, 192),
+    (201, 144, 192),
+]

{neo4j_viz-0.2.6 → neo4j_viz-0.3.0}/src/neo4j_viz/gds.py

@@ -6,7 +6,7 @@ from typing import Optional
 import pandas as pd
 from graphdatascience import Graph, GraphDataScience
 
-from .pandas import from_dfs
+from .pandas import _from_dfs
 from .visualization_graph import VisualizationGraph
 
 
@@ -35,6 +35,11 @@ def from_gds(
     """
     Create a VisualizationGraph from a GraphDataScience object and a Graph object.
 
+    All `additional_node_properties` will be included in the visualization graph.
+    If the properties are named as the fields of the `Node` class, they will be included as top level fields of the
+    created `Node` objects. Otherwise, they will be included in the `properties` dictionary.
+    Additionally, a new "labels" node property will be added, containing the node labels of the node.
+
     Parameters
     ----------
     gds : GraphDataScience
@@ -75,9 +80,13 @@ def from_gds(
 
     node_props_df = pd.concat(node_dfs.values(), ignore_index=True, axis=0).drop_duplicates()
     if size_property is not None:
+        if "size" in actual_node_properties and size_property != "size":
+            node_props_df.rename(columns={"size": "__size"}, inplace=True)
         node_props_df.rename(columns={size_property: "size"}, inplace=True)
 
     for lbl, df in node_dfs.items():
+        if "labels" in actual_node_properties:
+            df.rename(columns={"labels": "__labels"}, inplace=True)
         df["labels"] = lbl
 
     node_lbls_df = pd.concat([df[["id", "labels"]] for df in node_dfs.values()], ignore_index=True, axis=0)
@@ -88,4 +97,4 @@ def from_gds(
     rel_df = _rel_df(gds, G)
     rel_df.rename(columns={"sourceNodeId": "source", "targetNodeId": "target"}, inplace=True)
 
-    return from_dfs(node_df, rel_df, node_radius_min_max=node_radius_min_max)
+    return _from_dfs(node_df, rel_df, node_radius_min_max=node_radius_min_max, rename_properties={"__size": "size"})