Graphinate 0.2.11__tar.gz → 0.2.13__tar.gz

{graphinate-0.2.11 → graphinate-0.2.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Graphinate
-Version: 0.2.11
+Version: 0.2.13
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
@@ -30,9 +30,9 @@ Requires-Python: >=3.9
 Requires-Dist: click==8.1.7
 Requires-Dist: inflect==7.0.0
 Requires-Dist: loguru==0.7.2
-Requires-Dist: matplotlib==3.8.2
+Requires-Dist: matplotlib==3.8.3
 Requires-Dist: networkx==3.2.1
-Requires-Dist: strawberry-graphql[asgi,opentelemetry]==0.218.0
+Requires-Dist: strawberry-graphql[asgi,opentelemetry]==0.219.2
 Provides-Extra: dev
 Requires-Dist: pipdeptree; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
@@ -45,17 +45,17 @@ Requires-Dist: mkdocs-material; extra == 'docs'
 Requires-Dist: mkdocs-section-index; extra == 'docs'
 Requires-Dist: mkdocstrings-python; extra == 'docs'
 Provides-Extra: plot
-Requires-Dist: scipy>=1.11.4; extra == 'plot'
+Requires-Dist: scipy>=1.12.0; extra == 'plot'
 Provides-Extra: server
 Requires-Dist: starlette-prometheus; extra == 'server'
-Requires-Dist: uvicorn[standard]>=0.24.0; extra == 'server'
+Requires-Dist: uvicorn[standard]>=0.27.0; extra == 'server'
 Provides-Extra: test
-Requires-Dist: faker>=20.0.3; extra == 'test'
-Requires-Dist: pytest-asyncio>=0.21.1; extra == 'test'
+Requires-Dist: faker>=23.2.1; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23.4; extra == 'test'
 Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
 Requires-Dist: pytest-randomly>=3.15.0; extra == 'test'
 Requires-Dist: pytest-xdist>=3.5.0; extra == 'test'
-Requires-Dist: pytest>=7.4.3; extra == 'test'
+Requires-Dist: pytest>=7.4.4; extra == 'test'
 Description-Content-Type: text/markdown
 
 # [Graphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)

graphinate-0.2.13/docs/intro.md

@@ -0,0 +1,110 @@
+# Introduction
+
+## What?
+
+### What is Graphinate?
+
+**Graphinate** is a python library that aims to simplify the generation of Graph Data Structures from Data Sources.
+
+It can help create an efficient retrieval pipeline from a given data source, while also enabling the developer to map
+data payloads and hierarchies to a Graph.
+
+In addition, there are several modes of output to enable examination of the Graph and its content.
+
+**Graphinate** utilizes and builds upon the excellent [**_NetworkX_**](https://networkx.org/).
+
+### What is a Graph?
+
+“In a mathematician's terminology, a graph is a collection of points and lines connecting some (possibly empty) subset
+of them.
+The points of a graph are most commonly known as graph *vertices*, but may also be called *nodes* or *points*.
+Similarly, the lines connecting the vertices of a graph are most commonly known as graph *edges*, but may also
+be called *arcs* or *lines*.”
+
+— [https://mathworld.wolfram.com/Graph.html](https://mathworld.wolfram.com/Graph.html)
+
+### What is Data?
+
+“...data is a collection of discrete or continuous values that convey information, describing the quantity, quality,
+fact, statistics, other basic units of meaning, or simply sequences of symbols that may be further interpreted
+formally.”
+
+— [https://en.wikipedia.org/wiki/Data](https://en.wikipedia.org/wiki/Data)
+
+## How?
+
+### A Graph as a Data Structure
+
+A Graph is a quite useful data structure.
+It is perhaps the simplest data structure, that is a bit more than just a
+simple collection of "things".
+As such, it can be used to model all data sources that have structure.
+
+### Graph Elements
+
+A Graph consists of two types of elements:
+
+#### Nodes
+
+A Graph Node can be any Python Hashable object. Usually it will be a primitive type such as an integer or a string,
+in particular when the node in itself has no special meaning.
+One can also add attributes to the node to describe additional information.
+This information can include anything. Often they are used to store scalar dimensions (e.g., weight, area, width, age etc.)
+or stylistic information (e.g., color, size, shape, label etc.).  
+
+#### Edges
+
+A Graph Edge is a tuple of two node values. It can also have additional attributes in the same vain as a Graph Node. 
+
+### Defining a Graph
+
+One can define a Graph in two general ways:
+
+#### Edge First
+
+The most straight forward way to generate a Graph is to supply a list of edges. The simplest definition of an edge is a
+tuple of two values. Each value represents a node (or vertex) in the graph. Attributes may be added to the edge
+definition to convey additional characteristics.
+
+In this case, one defines the **edges explicitly** and the **nodes implicitly**.
+
+Such a graph is focused more on the _relationships_ between nodes or the _structure_ of the graph than on the nodes themselves.
+
+#### Node First
+
+Alternatively, one can first add nodes (vertices) to a graph without defining edges. Attributes may be added
+to the node definitions to convey additional characteristics. After that, edge definitions are added to generate the
+relationships between the nodes.
+
+In this case, **both nodes and the edges** are defined **explicitly**.
+
+Such a graph has focus, first on the nodes, and then on the relationship between them.
+
+### Graphinate 
+
+"Hydrate" a Graph from a Data Source.
+Using Graphinate enables generating graphs from data sources.
+It supports both *Edge First* and *Node First* creation scenarios.
+
+This is achieved following these steps: 
+
+#### Source 
+
+It is required to represent the Data sources as an Iterable of items that will be transformed to graph edges
+and/or nodes.
+It is recommended to use Generators as the items Iterables.
+
+#### Model
+
+Using Graphinate GraphMode decorators, we can define how to transform the items supplied by the data source generators,
+to graph elements.
+
+#### Build
+A Graph Model can be used to generate an actual instance of a Graph.
+It is achieved by using a GraphBuilder to both retrieve the data and assemble the Graph. 
+Several formats are available.
+
+#### Materialize
+
+Finally, we can use the builders to Materialize the graph in several ways that support different use cases 
+(i.e., visualizing, querying, reporting, etc.) 

{graphinate-0.2.11 → graphinate-0.2.13}/docs/usage/lib.md

@@ -18,7 +18,7 @@
 
 ## SDK
 
-### Modeling
+### Model
 
 * [`graphinate.GraphModel`](/reference/graphinate/modeling/#graphinate.modeling.GraphModel)
 
@@ -28,7 +28,7 @@
 
 * [`graphinate.NodeModel`](/reference/graphinate/modeling/#graphinate.modeling.NodeModel) - TBD
 
-### Builders
+### Build
 
 * [`graphinate.builders.NetworkxBuilder`](/reference/graphinate/builders/#graphinate.builders.NetworkxBuilder) -
   Generates a NetworkX Graph instance.
@@ -39,10 +39,10 @@
 * [`graphinate.builders.GraphQLBuilder`](/reference/graphinate/builders/#graphinate.builders.GraphQLBuilder) - Generates
   a Strawberry GraphQL Schema instance
 
-### Actualizers
+### Actualize
 
 > TBD
 
-### Materializers
+### Materialize
 
 > TBD

{graphinate-0.2.11 → graphinate-0.2.13}/examples/code/python_dependencies.py

@@ -28,5 +28,5 @@ if __name__ == '__main__':
     graphinate.materialize(
         dependency_model,
         builder=graphinate.builders.GraphQLBuilder,
-        actualizer=graphinate.plot
+        actualizer=graphinate.graphql
     )

{graphinate-0.2.11 → graphinate-0.2.13}/mkdocs.yml

@@ -68,8 +68,8 @@ markdown_extensions:
       use_pygments: true
       pygments_lang_class: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.inlinehilite
   - pymdownx.snippets
   - pymdownx.superfences

{graphinate-0.2.11 → graphinate-0.2.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Graphinate"
-version = "0.2.11"
+version = "0.2.13"
 authors = [
     { name = "Eran Rivlis", email = "eran@rivlis.info" },
 ]
@@ -31,9 +31,9 @@ dependencies = [
     "click==8.1.7",
     "inflect==7.0.0",
     "loguru==0.7.2",
-    "matplotlib==3.8.2",
+    "matplotlib==3.8.3",
     "networkx==3.2.1",
-    "strawberry-graphql[asgi,opentelemetry]==0.218.0"
+    "strawberry-graphql[asgi,opentelemetry]==0.219.2"
 ]
 
 
@@ -59,19 +59,19 @@ docs = [
     "mkdocs-section-index",
 ]
 test = [
-    "faker>=20.0.3",
-    "pytest>=7.4.3",
-    "pytest-asyncio>=0.21.1",
+    "faker>=23.2.1",
+    "pytest>=7.4.4",
+    "pytest-asyncio>=0.23.4",
     "pytest-cov>=4.1.0",
     "pytest-randomly>=3.15.0",
     "pytest-xdist>=3.5.0"
 ]
 plot = [
-    "scipy>=1.11.4"
+    "scipy>=1.12.0"
 ]
 server = [
     "starlette-prometheus",
-    "uvicorn[standard]>=0.24.0"
+    "uvicorn[standard]>=0.27.0"
 ]
 
 
@@ -102,15 +102,17 @@ exclude_also = [
     "if TYPE_CHECKING:",
     "class .*\\bProtocol\\):",
     "@(abc\\.)?abstractmethod"
-    ]
+]
 
 
 [tool.black]
 line-length = 120
 #extend-exclude = ''
 
-
 [tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
 select = [
     "E",
     "F",
@@ -154,15 +156,14 @@ exclude = [
 ]
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
-line-length = 120
 
 
-[tool.ruff.flake8-quotes]
+[tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 inline-quotes = "single"
 multiline-quotes = "single"
 
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 # Unlike Flake8, default to a complexity level of 10.
 max-complexity = 15

graphinate-0.2.13/src/graphinate/server/__init__.py

@@ -0,0 +1,108 @@
+import contextlib
+import webbrowser
+
+import strawberry
+from starlette.applications import Starlette
+from starlette.schemas import SchemaGenerator
+from strawberry.asgi import GraphQL
+from strawberry.extensions.tracing import OpenTelemetryExtension
+
+from .starlette import routes
+
+DEFAULT_PORT: int = 8072
+
+
+def openapi_schema(request):
+    schema = SchemaGenerator(
+        {
+            "openapi": "3.0.0",
+            "info": {"title": "Graphinate API", "version": "1.0"},
+            "paths": {
+                "/graphql": {
+                    "get": {
+                        "responses": {
+                            200: {
+                                "description": "GraphQL"
+                            }
+                        }
+                    }
+                },
+                "/graphiql": {
+                    "get": {
+                        "responses": {
+                            200: {
+                                "description": "GraphiQL UI."
+                            }
+                        }
+                    }
+                },
+                "/metrics": {
+                    "get": {
+                        "responses": {
+                            200: {
+                                "description": "Prometheus metrics."
+                            }
+                        }
+                    }
+                },
+                "/viewer": {
+                    "get": {
+                        "responses": {
+                            200: {
+                                "description": "3D Force-Directed Graph Viewer"
+                            }
+                        }
+                    }
+                },
+                "/voyager": {
+                    "get": {
+                        "responses": {
+                            200: {
+                                "description": "Voyager GraphQL Schema Viewer"
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    )
+    return schema.OpenAPIResponse(request=request)
+
+
+def graphql(graphql_schema: strawberry.Schema, port: int = DEFAULT_PORT):
+    """
+
+    Args:
+        graphql_schema:
+        port:
+
+    Returns:
+
+    """
+    graphql_schema.extensions.append(OpenTelemetryExtension)
+
+    @contextlib.asynccontextmanager
+    async def lifespan(app: Starlette):  # pragma: no cover
+        def open_url():
+            for app_name in ('voyager', 'graphiql', 'viewer'):
+                webbrowser.open(f'http://localhost:{port}/{app_name}')
+
+        open_url()
+        yield
+
+    graphql_app: GraphQL = GraphQL(graphql_schema)
+    app = Starlette(
+        lifespan=lifespan,
+        routes=routes()
+    )
+    app.add_route("/graphql", graphql_app)
+    app.add_websocket_route("/graphql", graphql_app)
+
+    from starlette_prometheus import PrometheusMiddleware, metrics
+    app.add_middleware(PrometheusMiddleware)
+    app.add_route("/metrics", metrics)
+
+    app.add_route("/schema", route=openapi_schema, include_in_schema=False)
+
+    import uvicorn
+    uvicorn.run(app, host='0.0.0.0', port=port)

graphinate-0.2.13/src/graphinate/server/web/elements/index.html

@@ -0,0 +1,20 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>Elements in HTML</title>
+    <!-- Embed elements Elements via Web Component -->
+    <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
+  </head>
+  <body>
+
+    <elements-api
+      apiDescriptionUrl="/schema"
+      router="hash"
+      layout="sidebar"
+    />
+
+  </body>
+</html>

graphinate-0.2.13/src/graphinate/server/web/rapidoc/index.html

@@ -0,0 +1,14 @@
+<!doctype html> <!-- Important: must specify -->
+<html lang="en">
+<head>
+  <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 characters -->
+  <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+  <title>Graphinate OpenAPI</title>
+</head>
+<body>
+  <rapi-doc
+    spec-url="/schema"
+    theme = "dark"
+  > </rapi-doc>
+</body>
+</html>

graphinate-0.2.11/docs/intro.md

@@ -1,74 +0,0 @@
-# Introduction
-
-## What?
-
-### What is Graphinate?
-
-**Graphinate** is a python library that aims to simplify the generation of Graph Data Structures from Data Sources.
-
-It can help create an efficient retrieval pipeline from a given data source, while also enabling the developer to easily
-map data payloads and hierarchies to a Graph.
-
-In addition, there are several modes of output to enable examination of the Graph, and it's content.
-
-**Graphinate** utilizes and builds upon the excellent [**_NetworkX_**](https://networkx.org/).
-
-### What is a Graph?
-
-“In a mathematician's terminology, a graph is a collection of points and lines connecting some (possibly empty) subset
-of them. The points of a graph are most commonly known as graph vertices, but may also be called "nodes" or simply "
-points." Similarly, the lines connecting the vertices of a graph are most commonly known as graph edges, but may also
-be called "arcs" or "lines."”
-
-— [https://mathworld.wolfram.com/Graph.html](https://mathworld.wolfram.com/Graph.html)
-
-### What is Data?
-
-“...data is a collection of discrete or continuous values that convey information, describing the quantity, quality,
-fact, statistics, other basic units of meaning, or simply sequences of symbols that may be further interpreted
-formally.”
-
-— [https://en.wikipedia.org/wiki/Data](https://en.wikipedia.org/wiki/Data)
-
-## How?
-
-### A Graph as a Data Structure
-
-A Graph is a quite useful data structure.
-It is perhaps the simplest data structure, that is a bit more than just a
-simple collection of "things".
-As such, it can be used to model all data sources that have structure.
-
-### Define a Graph
-
-One can define a Graph in two general ways:
-
-#### Edge first
-
-The most straight forward way to Generate a Graph is to supply a list of edges. The simplest definition of an edge is a
-tuple of two values. Each value represents a node (or vertex) in the graph. Additional attributes may be added to the edge
-definition to convey additional characteristics.
-
-In this case, one defines the **edges explicitly** and the **nodes implicitly**.
-
-Such graph is focused more on the _relationships_ or the _structure_ of the Graph than on the nodes themselves.
-
-!!! Example
-    TBD
-
-#### Node first
-
-Alternatively, one can first add nodes (vertices) to a graph without defining edges. Additional attributes may be added
-to the node definitions to convey additional characteristics. After that, edge definitions are added to generate the
-relationships between the nodes.
-
-In this case, **both nodes and the edges** are defined **explicitly**.
-
-Such a graph has focus, first on the nodes, and then on the relationship between them.
-
-!!! Example
-    TBD
-
-### Graphinate - "Hydrate" a Graph from a Data Source
-
-> TBD

graphinate-0.2.11/src/graphinate/server/__init__.py

@@ -1,48 +0,0 @@
-import contextlib
-import webbrowser
-
-import strawberry
-from starlette.applications import Starlette
-from strawberry.asgi import GraphQL
-from strawberry.extensions.tracing import OpenTelemetryExtension
-
-from .starlette import routes
-
-DEFAULT_PORT: int = 8072
-
-
-def graphql(graphql_schema: strawberry.Schema, port: int = DEFAULT_PORT):
-    """
-
-    Args:
-        graphql_schema:
-        port:
-
-    Returns:
-
-    """
-    graphql_schema.extensions.append(OpenTelemetryExtension)
-
-    @contextlib.asynccontextmanager
-    async def lifespan(app: Starlette):  # pragma: no cover
-        def open_url():
-            for app_name in ('voyager', 'graphiql', 'viewer'):
-                webbrowser.open(f'http://localhost:{port}/{app_name}')
-
-        open_url()
-        yield
-
-    graphql_app: GraphQL = GraphQL(graphql_schema)
-    app = Starlette(
-        lifespan=lifespan,
-        routes=routes()
-    )
-    app.add_route("/graphql", graphql_app)
-    app.add_websocket_route("/graphql", graphql_app)
-
-    from starlette_prometheus import PrometheusMiddleware, metrics
-    app.add_middleware(PrometheusMiddleware)
-    app.add_route("/metrics", metrics)
-
-    import uvicorn
-    uvicorn.run(app, host='0.0.0.0', port=port)