Graphinate 0.8.4__tar.gz → 0.8.5__tar.gz

{graphinate-0.8.4 → graphinate-0.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Graphinate
-Version: 0.8.4
+Version: 0.8.5
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
@@ -33,7 +33,7 @@ Requires-Dist: loguru
 Requires-Dist: mappingtools
 Requires-Dist: matplotlib
 Requires-Dist: networkx
-Requires-Dist: networkx-mermaid>=0.1.0
+Requires-Dist: networkx-mermaid
 Requires-Dist: strawberry-graphql[asgi,opentelemetry]
 Provides-Extra: plot
 Requires-Dist: scipy; extra == 'plot'

{graphinate-0.8.4 → graphinate-0.8.5}/examples/github/_client.py

@@ -30,7 +30,7 @@ def github_user(user_id: Optional[str] = None) -> Union[NamedUser, Authenticated
     """
     Get the GitHub user object for the specified user ID or the authenticated user.
 
-    Parameters:
+    Args:
         user_id (Optional[str]): The ID of the user to retrieve.
                                  If not provided, retrieve the authenticated user.
 
@@ -51,7 +51,7 @@ def github_repositories(
     """
     Get the GitHub repositories for the specified user ID or the authenticated user.
 
-    Parameters:
+    Args:
         user_id (Optional[str]): The ID of the user whose repositories to retrieve.
                                  If not provided, retrieve repositories of the authenticated user.
         repo_id (Optional[str]): The ID of the repository to retrieve.
@@ -78,7 +78,7 @@ def github_commits(
     """
     Retrieve commits from a GitHub repository.
 
-    Parameters:
+    Args:
         repo (Repository): The GitHub repository object from which to retrieve commits.
         commit_id (str, optional): The ID of the commit to retrieve.
                                    If provided, only that commit will be returned.
@@ -115,7 +115,7 @@ def github_files(
     """
     Retrieves Files from a GitHub Commit
 
-    Parameters:
+    Args:
         commit (Commit): A Commit object from the GitHub API.
         file_id (Optional[str]): An optional parameter specifying the filename to filter the files. Default is None.
 

{graphinate-0.8.4 → graphinate-0.8.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Graphinate"
-version = "0.8.4"
+version = "0.8.5"
 description = "Graphinate. Data to Graphs."
 authors = [
     { name = "Eran Rivlis", email = "eran@rivlis.info" },
@@ -34,7 +34,7 @@ dependencies = [
     "mappingtools",
     "matplotlib",
     "networkx",
-    "networkx-mermaid>=0.1.0",
+    "networkx-mermaid",
     "strawberry-graphql[asgi,opentelemetry]",
 ]
 

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/builders.py

@@ -15,9 +15,10 @@ from collections.abc import Callable, Hashable, Mapping
 from datetime import datetime
 from enum import Enum
 from types import MappingProxyType
-from typing import Any, Optional, Union
+from typing import Any, Literal, Optional, Union
 
 import inflect
+import mappingtools
 import networkx as nx
 import networkx_mermaid as nxm
 import strawberry
@@ -299,17 +300,27 @@ class D3Builder(NetworkxBuilder):
     def __init__(self, model: GraphModel, graph_type: GraphType = GraphType.Graph):
         super().__init__(model, graph_type)
 
-    def build(self, **kwargs) -> GraphRepresentation:
+    def build(self, values_format: Literal['json', 'python'] = 'python', **kwargs) -> GraphRepresentation:
         """
 
         Args:
+            values_format: Literal['python', 'json'] - The format of the values
             **kwargs:
 
         Returns:
             D3 Graph
         """
         super().build(**kwargs)
-        return self.from_networkx(self._graph)
+        color.convert_colors_to_hex(self._graph)
+        d3graph = self.from_networkx(self._graph)
+
+        match values_format:
+            case 'json':
+                return mappingtools.transformers.strictify(d3graph, value_converter=json.dumps)
+            case 'python':
+                return d3graph
+            case _:
+                raise ValueError(f"Invalid values format: {values_format}")
 
     @staticmethod
     def from_networkx(nx_graph: nx.Graph):
@@ -326,6 +337,7 @@ class MermaidBuilder(NetworkxBuilder):
     def build(self,
               orientation: nxm.DiagramOrientation = nxm.DiagramOrientation.LEFT_RIGHT,
               node_shape: nxm.DiagramNodeShape = nxm.DiagramNodeShape.DEFAULT,
+              title: str | None = None,
               with_edge_labels: bool = False,
               **kwargs) -> nxm.typing.MermaidDiagram:
         """
@@ -336,6 +348,10 @@ class MermaidBuilder(NetworkxBuilder):
             The orientation of the graph, by default Orientation.LEFT_RIGHT.
           node_shape : NodeShape, optional
             The shape of the nodes, by default NodeShape.DEFAULT.
+          title: str, optional
+            The title of the graph (default: None).
+            If None, the graph name will be used if available.
+            Supplying and empty string will remove the title.
           with_edge_labels:
             Whether to include edge labels, by default False.
           **kwargs: additional inputs to the node and edge generator functions
@@ -346,7 +362,7 @@ class MermaidBuilder(NetworkxBuilder):
         super().build(**kwargs)
         color.convert_colors_to_hex(self._graph)
         nxm_builder = nxm.DiagramBuilder(orientation=orientation, node_shape=node_shape)
-        return nxm_builder.build(self._graph, with_edge_labels=with_edge_labels)
+        return nxm_builder.build(self._graph, title=title, with_edge_labels=with_edge_labels)
 
 
 class GraphQLBuilder(NetworkxBuilder):
@@ -797,7 +813,7 @@ def build(builder_cls: type[Builder],
     """
     Build a graph from a graph model
 
-    Parameters:
+    Args:
         builder_cls: builder class type
         graph_model: a GraphModel instance
         graph_type: type of the generated graph

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/color.py

@@ -8,14 +8,24 @@ import networkx as nx
 
 @functools.lru_cache
 def node_color_mapping(graph: nx.Graph, cmap: Union[str, mpl.colors.Colormap] = "tab20") -> Mapping:
-    """
-    Parameters:
+    """Map node types to RGBA colors based on a colormap.
+    Args:
         graph: nx.Graph - The input graph for which node colors need to be mapped.
         cmap: Union[str, mpl.colors.Colormap], optional - The colormap used to map values to RGBA colors.
               Default is "tab20".
     Returns:
         Mapping - A dictionary mapping nodes to their corresponding RGBA colors based on the colormap.
+
+    .. note::
+        The graph should have a 'node_types' attribute containing the types of nodes.
+        The colormap can be specified as a string or a matplotlib colormap object.
     """
+
+    node_types = graph.graph.get('node_types', {})
+
+    if len(node_types) > 1 and 'node' in node_types:
+        node_types.pop('node')
+
     type_lookup = {t: i for i, t in enumerate(graph.graph['node_types'].keys())}
     color_lookup = {node: type_lookup.get(data.get('type'), 0) for node, data in graph.nodes.data()}
     if len(color_lookup) > 1:
@@ -31,10 +41,14 @@ def node_color_mapping(graph: nx.Graph, cmap: Union[str, mpl.colors.Colormap] =
 def color_hex(color: Union[str, Sequence[Union[float, int]]]) -> Union[str, Sequence[Union[float, int]]]:
     """Get HEX color code
 
-    Parameters:
+    Args:
         color: input color
     Returns:
          Color HEX code
+
+    .. note::
+        If the input is a tuple or list, it should contain either three floats (0-1) or three ints (0-255).
+        The function will convert these to a HEX color code.
     """
     if isinstance(color, (tuple, list)):  # noqa: UP038
         rgb = color[:3]
@@ -52,7 +66,20 @@ def color_hex(color: Union[str, Sequence[Union[float, int]]]) -> Union[str, Sequ
     else:
         return color
 
-def convert_colors_to_hex(graph: nx.Graph):
-    """Convert all color labels in the graph to hexadecimal format."""
-    color_values = {node: color_hex(data['color']) for node, data in graph.nodes(data=True) if 'color' in data}
-    nx.set_node_attributes(graph, values=color_values, name='color')
+
+def convert_colors_to_hex(graph: nx.Graph, color: str = 'color') -> None:
+    """Convert all color labels in the graph to hexadecimal format.
+
+    Args:
+        graph (nx.Graph): The input graph with node attributes.
+        color (str): The attribute name for the color. Default is 'color'.
+
+    Returns:
+        None: The function modifies the graph in place.
+
+    .. note::
+       This function assumes that the color attribute is present in the node data.
+    """
+
+    color_values = {node: color_hex(data[color]) for node, data in graph.nodes(data=True) if color in data}
+    nx.set_node_attributes(graph, values=color_values, name=color)

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/modeling.py

@@ -114,7 +114,7 @@ class GraphModel:
     Used to declaratively register Edge and/or Node data supplier functions by using
     decorators.
 
-    Parameters:
+    Args:
         name: the archetype name for Graphs generated based on the GraphModel.
     """
 
@@ -166,7 +166,7 @@ class GraphModel:
     def node_children_types(self, _type: str = UniverseNode) -> dict[str, list[str]]:
         """Children Node Types for given input Node Type
 
-        Parameters:
+        Args:
             _type:  Node Type. Default value is UNIVERSE_NODE.
 
         Returns:
@@ -200,7 +200,7 @@ class GraphModel:
         """Decorator to Register a Generator of node payloads as a source for Graph Nodes.
         It creates a NodeModel object.
 
-        Parameters:
+        Args:
             type_: Optional source for the Node Type. Defaults to use Generator function
                    name as the Node Type.
             parent_type: Optional parent Node Type. Defaults to UNIVERSE_NODE
@@ -253,7 +253,7 @@ class GraphModel:
         """Decorator to Register a generator of edge payloads as a source of Graph Edges.
          It creates an Edge generator function.
 
-        Parameters:
+        Args:
             type_: Optional source for the Edge Type. Defaults to use Generator function
                    name as the Edge Type.
             source: Source for edge source Node ID.
@@ -296,7 +296,7 @@ class GraphModel:
         """Rectify the model.
            Add a default NodeModel in case of having just edge supplier/s and no node supplier/s.
 
-           Parameters:
+           Args:
                _type
                parent_type
                key

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/renderers/graphql.py

@@ -29,7 +29,7 @@ def _openapi_schema(request: Request) -> ASGIApp:
     """
     schema_data = {
         'openapi': '3.0.0',
-        'info': {'title': 'Graphinate API', 'version': '0.8.4'},
+        'info': {'title': 'Graphinate API', 'version': '0.8.5'},
         'paths': {
             '/graphql': {'get': {'responses': {200: {'description': 'GraphQL'}}}},
             '/graphiql': {'get': {'responses': {200: {'description': 'GraphiQL UI.'}}}},

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/renderers/matplotlib.py

@@ -11,7 +11,7 @@ def draw(graph: nx.Graph,
     """
     Draws the given networkx graph with optional node and edge labels.
 
-    Parameters:
+    Args:
         graph (nx.Graph): The input graph to be drawn.
         with_node_labels (bool): Whether to display node labels. Default is True.
         with_edge_labels (bool): Whether to display edge labels. Default is False.

{graphinate-0.8.4 → graphinate-0.8.5}/src/graphinate/server/web/viewer/index.html

@@ -65,24 +65,6 @@
 <body>
 <div id="3d-graph"></div>
 <script>
-    // region GraphQL
-
-    const graphQuery = `query GenericGraph{nodes{...Details} links: edges{source{...Details} target{...Details} ...Details}} fragment Details on GraphElement {id label type color}`;
-    const nodeTypesQuery = `query GraphTypes{graph{name nodeTypes: nodeTypeCounts{name count: value} edgeTypes: edgeTypeCounts{name count: value}}}`;
-
-    function fetchGraphQL(payload) {
-        return fetch(
-            '/graphql',
-            {
-                method: 'post',
-                headers: {Accept: 'application/json', 'Content-Type': 'application/json'},
-                body: JSON.stringify(payload),
-                credentials: 'include',
-            }).then((response) => response.json());
-    }
-
-    // endregion GraphQL
-
     // region FloatingIFramePanel
     let highestZIndex = 0;
     let lastPanelPosition = {top: 50, left: 50};
@@ -299,6 +281,25 @@
 
     // endregion FloatingIFramePanel
 
+    // region GraphQL
+
+    const graphQuery = `query GenericGraph{nodes{...Details} links: edges{source{...Details} target{...Details} ...Details}} fragment Details on GraphElement {id label type color}`;
+    const nodeTypesQuery = `query GraphTypes{graph{name nodeTypes: nodeTypeCounts{name count: value} edgeTypes: edgeTypeCounts{name count: value}}}`;
+
+    function fetchGraphQL(payload) {
+        return fetch(
+            '/graphql',
+            {
+                method: 'post',
+                headers: {Accept: 'application/json', 'Content-Type': 'application/json'},
+                body: JSON.stringify(payload),
+                credentials: 'include',
+            }).then((response) => response.json());
+    }
+
+    // endregion GraphQL
+
+    // region ForceGraph3D
     const nodeTypeColor = {}
     const nodeTypeVisibility = {};
     let graphParams = {
@@ -659,6 +660,8 @@
                     createGraphControlPanel(data.graph, gData);
                 });
         });
+
+    // endregion ForceGraph3D
 </script>
 </body>
 </html>