Graphinate 0.3.2__tar.gz → 0.5.0__tar.gz

{graphinate-0.3.2 → graphinate-0.5.0}/.github/workflows/test-beta.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         # https://github.com/actions/python-versions/blob/main/versions-manifest.json
-        python-version: [ "3.14.0-alpha.2" ]
+        python-version: [ "3.14.0-alpha.4" ]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}

{graphinate-0.3.2 → graphinate-0.5.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: Graphinate
-Version: 0.3.2
-Summary: Graphinate. Data to Graphs.
+Version: 0.5.0
+Summary: 𝔾raphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
 Project-URL: Bug Tracker, https://github.com/erivlis/graphinate/issues
@@ -58,7 +58,7 @@ Requires-Dist: pytest-randomly; extra == 'test'
 Requires-Dist: pytest-xdist; extra == 'test'
 Description-Content-Type: text/markdown
 
-# [Graphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)
+# [𝔾raphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)
 
 <img height="360" src="https://github.com/erivlis/graphinate/assets/9897520/dae41f9f-69e5-4eb5-a488-87ce7f51fa32" alt="Graphinate. Data to Graphs.">
 
@@ -73,7 +73,7 @@ Description-Content-Type: text/markdown
       <img alt="Libraries.io SourceRank" src="https://img.shields.io/librariesio/sourcerank/pypi/Graphinate.svg?logo=Libraries.io&label=SourceRank">
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Code</td>
     <td>
       <img alt="GitHub" src="https://img.shields.io/github/license/erivlis/graphinate">
@@ -82,7 +82,7 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/erivlis/graphinate/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/erivlis/graphinate.svg?&logo=git"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Tools</td>
     <td>
       <a href="https://www.jetbrains.com/pycharm/"><img alt="PyCharm" src="https://img.shields.io/badge/PyCharm-FCF84A.svg?logo=PyCharm&logoColor=black&labelColor=21D789&color=FCF84A"></a>
@@ -93,16 +93,16 @@ Description-Content-Type: text/markdown
       <a href="https://hatch.pypa.io"><img alt="Hatch project" class="off-glb" loading="lazy" src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>CI/CD</td>
     <td>
-      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master"></a>
-      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml/badge.svg?branch=master"></a>
+      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Test" src="https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg"></a>
+      <a href="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml"><img alt="Test (Beta)" src="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml/badge.svg"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish.yml"><img alt="Publish" src="https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml"><img alt="Publish Docs" src="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml/badge.svg"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Scans</td>
     <td>
       <a href="https://codecov.io/gh/erivlis/graphinate"><img alt="Coverage" src="https://codecov.io/gh/erivlis/graphinate/graph/badge.svg?token=POODT8M9NV"/></a>
@@ -120,22 +120,26 @@ Description-Content-Type: text/markdown
       <a href="https://snyk.io/test/github/erivlis/graphinate"><img alt="Snyk" src="https://snyk.io/test/github/erivlis/Graphinate/badge.svg"></a>
     </td>
   </tr>
+  <tr>
+    <td>Badge</td>
+    <td>
+       <a href="https://img.shields.io/badge/%F0%9D%94%BE%3D%7B%F0%9D%95%8D%2C%F0%9D%94%BC%7D-Graphinate-darkviolet"><img alt="Graphinate" src="https://img.shields.io/badge/%F0%9D%94%BE%3D%7B%F0%9D%95%8D%2C%F0%9D%94%BC%7D-Graphinate-darkviolet"></a>
+    </td>
+  </tr>
 </table>
 
----------------------
-
 ## Introduction
 
 ### What is Graphinate?
 
-**Graphinate** is a python library that aims to simplify the generation of Graph Data Structures from Data Sources.
+**Graphinate** is a python library that can be used to generate 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.
+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 it's content.
+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/).
+**Graphinate** uses and builds upon the excellent [**_NetworkX_**](https://networkx.org/).
 
 ### Links
 
@@ -163,25 +167,28 @@ pip install graphinate[server]
 
 ### Example
 
-```python
+```python title="Octagonal Graph"
 import graphinate
 
 N: int = 8
 
-# Define GraphModel
-graph_model = graphinate.model(name="Octagonal Graph")
+# Define a GraphModel
+graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")
 
 
-# Register edges supplier function
+# Register in the Graph Model the edges' supplier function
 @graph_model.edge()
 def edge():
-    for i in range(N - 1):
+    for i in range(N):
         yield {'source': i, 'target': i + 1}
-    yield {'source': N - 1, 'target': 0}
+    yield {'source': N, 'target': 0}
+
 
+# Choose builder and handler
+builder, handler = graphinate.materializers.Materializers.NetworkX_with_edge_labels.value
 
 # Materialize the GraphModel
-graphinate.materialize(graph_model)
+graphinate.materialize(graph_model, builder=builder, builder_output_handler=handler)
 ```
 
 #### `graphinate.model` function
@@ -194,7 +201,6 @@ graphinate.materialize(graph_model)
 
 > [!NOTE]
 > This function can be used to easily generate an output from a `GraphModel` instance.
-> By default, it will prompt the user to choose the output format, using a popup GUI dialog box.
 
 ## CLI
 

{graphinate-0.3.2 → graphinate-0.5.0}/README.md

@@ -1,4 +1,4 @@
-# [Graphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)
+# [𝔾raphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)
 
 <img height="360" src="https://github.com/erivlis/graphinate/assets/9897520/dae41f9f-69e5-4eb5-a488-87ce7f51fa32" alt="Graphinate. Data to Graphs.">
 
@@ -13,7 +13,7 @@
       <img alt="Libraries.io SourceRank" src="https://img.shields.io/librariesio/sourcerank/pypi/Graphinate.svg?logo=Libraries.io&label=SourceRank">
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Code</td>
     <td>
       <img alt="GitHub" src="https://img.shields.io/github/license/erivlis/graphinate">
@@ -22,7 +22,7 @@
       <a href="https://github.com/erivlis/graphinate/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/erivlis/graphinate.svg?&logo=git"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Tools</td>
     <td>
       <a href="https://www.jetbrains.com/pycharm/"><img alt="PyCharm" src="https://img.shields.io/badge/PyCharm-FCF84A.svg?logo=PyCharm&logoColor=black&labelColor=21D789&color=FCF84A"></a>
@@ -33,16 +33,16 @@
       <a href="https://hatch.pypa.io"><img alt="Hatch project" class="off-glb" loading="lazy" src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>CI/CD</td>
     <td>
-      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master"></a>
-      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml/badge.svg?branch=master"></a>
+      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Test" src="https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg"></a>
+      <a href="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml"><img alt="Test (Beta)" src="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml/badge.svg"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish.yml"><img alt="Publish" src="https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml"><img alt="Publish Docs" src="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml/badge.svg"></a>
     </td>
   </tr>
-  <tr>
+  <tr style="vertical-align: middle;">
     <td>Scans</td>
     <td>
       <a href="https://codecov.io/gh/erivlis/graphinate"><img alt="Coverage" src="https://codecov.io/gh/erivlis/graphinate/graph/badge.svg?token=POODT8M9NV"/></a>
@@ -60,22 +60,26 @@
       <a href="https://snyk.io/test/github/erivlis/graphinate"><img alt="Snyk" src="https://snyk.io/test/github/erivlis/Graphinate/badge.svg"></a>
     </td>
   </tr>
+  <tr>
+    <td>Badge</td>
+    <td>
+       <a href="https://img.shields.io/badge/%F0%9D%94%BE%3D%7B%F0%9D%95%8D%2C%F0%9D%94%BC%7D-Graphinate-darkviolet"><img alt="Graphinate" src="https://img.shields.io/badge/%F0%9D%94%BE%3D%7B%F0%9D%95%8D%2C%F0%9D%94%BC%7D-Graphinate-darkviolet"></a>
+    </td>
+  </tr>
 </table>
 
----------------------
-
 ## Introduction
 
 ### What is Graphinate?
 
-**Graphinate** is a python library that aims to simplify the generation of Graph Data Structures from Data Sources.
+**Graphinate** is a python library that can be used to generate 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.
+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 it's content.
+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/).
+**Graphinate** uses and builds upon the excellent [**_NetworkX_**](https://networkx.org/).
 
 ### Links
 
@@ -103,25 +107,28 @@ pip install graphinate[server]
 
 ### Example
 
-```python
+```python title="Octagonal Graph"
 import graphinate
 
 N: int = 8
 
-# Define GraphModel
-graph_model = graphinate.model(name="Octagonal Graph")
+# Define a GraphModel
+graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")
 
 
-# Register edges supplier function
+# Register in the Graph Model the edges' supplier function
 @graph_model.edge()
 def edge():
-    for i in range(N - 1):
+    for i in range(N):
         yield {'source': i, 'target': i + 1}
-    yield {'source': N - 1, 'target': 0}
+    yield {'source': N, 'target': 0}
+
 
+# Choose builder and handler
+builder, handler = graphinate.materializers.Materializers.NetworkX_with_edge_labels.value
 
 # Materialize the GraphModel
-graphinate.materialize(graph_model)
+graphinate.materialize(graph_model, builder=builder, builder_output_handler=handler)
 ```
 
 #### `graphinate.model` function
@@ -134,7 +141,6 @@ graphinate.materialize(graph_model)
 
 > [!NOTE]
 > This function can be used to easily generate an output from a `GraphModel` instance.
-> By default, it will prompt the user to choose the output format, using a popup GUI dialog box.
 
 ## CLI
 

graphinate-0.5.0/docs/assets/stylesheets/extra.css

@@ -0,0 +1,64 @@
+/* extra.css */
+
+/*
+:root {
+  --md-primary-fg-color:        #E3963E;
+  --md-primary-fg-color--dark:  #FFBF00;
+  --md-primary-fg-color--light: #EBA937;
+}
+*/
+
+:root {
+    --md-primary-fg-color: rebeccapurple;
+    --md-primary-fg-color--dark: midnight;
+    --md-primary-fg-color--light: silver;
+}
+
+
+/* Title levels */
+h1 {
+    color: royalblue;
+}
+
+h2 {
+    color: slateblue;
+}
+
+h3 {
+    color: mediumslateblue;
+}
+
+h4, h5, h6 {
+    color: steelblue;
+}
+
+/* Blockquotes */
+/*blockquote {*/
+/*    border-left: 4px solid #bdc3c7; !* Light gray *!*/
+/*    color: #7f8c8d; !* Gray *!*/
+/*    !*background-color: #ecf0f1; !* Very light gray *!*!*/
+/*    padding: 10px;*/
+/*}*/
+
+/* Code blocks */
+/*pre, code {*/
+/*    background-color: #f8f9fa; !* Very light gray *!*/
+/*    color: #2c3e50; !* Dark blue *!*/
+/*}*/
+
+/* Tables */
+/*table {*/
+/*    border-collapse: collapse;*/
+/*    width: 100%;*/
+/*}*/
+
+/*th, td {*/
+/*    border: 1px solid #bdc3c7; !* Light gray *!*/
+/*    padding: 8px;*/
+/*    text-align: left;*/
+/*}*/
+
+/*th {*/
+/*    background-color: #ecf0f1; !* Very light gray *!*/
+/*    color: #2c3e50; !* Dark blue *!*/
+/*}*/

{graphinate-0.3.2 → graphinate-0.5.0}/docs/examples/github.md

@@ -3,42 +3,35 @@
 ## Repositories
 
 === "Repositories"
-
     ``` python title="examples/github/repositories.py" linenums="1"
     --8<-- "examples/github/repositories.py"
     ```
 
 === "Dependencies"
-
     ``` text title="examples/github/requirements.txt" linenums="1"
     --8<-- "examples/github/requirements.txt"
     ```
 
-
     ``` python title="examples/github/_client.py" linenums="1"
     --8<-- "examples/github/_client.py"
     ```
 
 === "Plot"
-
     ![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
 
 
 ## Followers
 
 === "Followers"
-
     ``` python title="examples/github/followers.py" linenums="1"
     --8<-- "examples/github/followers.py"
     ```
 
 === "Dependencies"
-
     ``` text title="examples/github/requirements.txt" linenums="1"
     --8<-- "examples/github/requirements.txt"
     ```
 
-
     ``` python title="examples/github/_client.py" linenums="1"
     --8<-- "examples/github/_client.py"
     ```

graphinate-0.5.0/docs/examples/math.md

@@ -0,0 +1,29 @@
+# Math
+
+## Graph Atlas
+
+=== "Graph Atlas"
+    ``` python title="examples/math/graph_atlas.py" linenums="1"
+    --8<-- "examples/math/graph_atlas.py"
+    ```
+
+=== "Dependencies"
+    ``` text title="examples/math/requirements.txt" linenums="1"
+    --8<-- "examples/math/requirements.txt"
+    ```
+    
+    ``` python title="examples/math/graph.py" linenums="1"
+    --8<-- "examples/math/graphs.py"
+    ```
+
+## Polygonal Graph
+
+=== "Polygonal Graph"
+    ``` python title="examples/math/polygonal_graph.py" linenums="1"
+    --8<-- "examples/math/polygonal_graph.py"
+    ```
+
+=== "Dependencies"
+    ``` text title="examples/math/requirements.txt" linenums="1"
+    --8<-- "examples/math/requirements.txt"
+    ```

{graphinate-0.3.2 → graphinate-0.5.0}/docs/index.md

@@ -2,55 +2,61 @@
 
 <table style="border-width: 0;">
   <tr style="vertical-align: middle; border-width: 0;">
-    <td rowspan="4"><img height="240" src="https://github.com/erivlis/graphinate/assets/9897520/dae41f9f-69e5-4eb5-a488-87ce7f51fa32" alt="Graphinate. Data to Graphs."></td>
+    <td rowspan="5"><img height="240" src="https://github.com/erivlis/graphinate/assets/9897520/dae41f9f-69e5-4eb5-a488-87ce7f51fa32" alt="Graphinate. Data to Graphs."></td>
     <td>Package</td>
     <td>
-      <img alt="PyPI - version" src="https://img.shields.io/pypi/v/graphinate">
-      <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/graphinate">
-      <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/graphinate">
-      <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dd/graphinate">
-      <br>
+      <img alt="PyPI - version" src="https://img.shields.io/pypi/v/graphinate.svg?logo=pypi&logoColor=lightblue">
+      <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/graphinate.svg?logo=pypi&logoColor=lightblue">
+      <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/graphinate.svg?logo=python&label=Python&logoColor=lightblue">
+      <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dd/graphinate.svg?logo=pypi&logoColor=lightblue">
+      <img alt="Libraries.io SourceRank" src="https://img.shields.io/librariesio/sourcerank/pypi/Graphinate.svg?logo=Libraries.io&label=SourceRank">
+    </td>
+  </tr>
+  <tr style="vertical-align: middle;">
+    <td>Code</td>
+    <td>
       <img alt="GitHub" src="https://img.shields.io/github/license/erivlis/graphinate">
-      <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/erivlis/graphinate">
-      <img alt="GitHub last commit (by committer)" src="https://img.shields.io/github/last-commit/erivlis/graphinate">
-      <a href="https://github.com/erivlis/graphinate/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/erivlis/graphinate.svg"></a>
- 	    <img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/erivlis/graphinate.svg">
+      <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/erivlis/graphinate.svg?label=Size&logo=git">
+      <img alt="GitHub last commit (by committer)" src="https://img.shields.io/github/last-commit/erivlis/graphinate.svg?&logo=git">
+      <a href="https://github.com/erivlis/graphinate/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/erivlis/graphinate.svg?&logo=git"></a>
     </td>
   </tr>
-  <tr  style="vertical-align: middle; border-width: 0;">
+  <tr style="vertical-align: middle;">
     <td>Tools</td>
     <td>
       <a href="https://www.jetbrains.com/pycharm/"><img alt="PyCharm" src="https://img.shields.io/badge/PyCharm-FCF84A.svg?logo=PyCharm&logoColor=black&labelColor=21D789&color=FCF84A"></a>
-      <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>
-      <a href="https://github.com/astral-sh/uv"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv" style="max-width:100%;"></a>
-      <a href="https://github.com/tox-dev/pipdeptree"><img src="https://img.shields.io/badge/pipdeptree-526CFE.svg?labelColor=gray&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAADFElEQVR4nFxTW2tcVRRe39773E/mliZjwKRmhBaKt4BWRKmGgihCH3xUKNWC/Q/ii76IP8AHpSIiRfqmD5YKCinalhgiCMZLSVtMM0mTdDLTuZyZc9l7yTlp7WXBgXPW+fa31rfWtxU9FLMN79Crr028e+iJsZfb7fJMp23xRlOvbTR3L/y5cuOL3Vbv7/vxuPviecI/eWr6k/mj4+8AkM11y+zs2MKwMJvNgIgYINZX/rlx+tIvf72fZXr4P0EQyOCjjw98P9vwn8+/+z3Bq6sek7AJkNhsOjQcyjvFmHd2upd+PP/zsSxNI5mnPvjw8U9fPFJ9XVkgNuDVayEbcgVEfgikNfFg4JAmh1LyyfGq06QqE9vN6+fEs4fHnjv25vjbAOA4AsL2MVZ1hRcI4QXIH7ilMqQXkiYXRBJRbFNQnTsRlqfmxFvH66ccFyAQMxP3I5cqNZBSxIWcKORMO9g3yeSHzFkGbnVCIkDUZ+beEy+8VJ4XguC6TMPYokwrCAHUJsBxYptoFBYSMi0oLIlcAkuFYhal8Zl5VanZU0zErgfurufMFjEkWZ7iRFY4SlgYfW9bUIJKFQNjiNPYf1QZOZn/hTaStPQKTI4eDCxSjsL4I6BeJzOjgcnT0HqPqwBJCdHZjW/miWjkkG3hzqKIe5FVlM3llGuWqOxTDMBkWlJ/6PB2p0Sb21gXixdvLeTtDGOHLFvQHpkiYyTuNU5kuxJercTdpEK3Bz4yLdFrXVsQ33x1/bModjhvyrKKVXB/YD9gb8PgKAlolAZipmFTOIYcxq21Xz8XS5dbi+e+2zqbA3MjxYninH3PpkyZljwYjZE2FoxBIWm6YVHaW/k66qwtF05curz509OHHzvqBqWp232fE+2AoCjOXNMfhcRcjAxxoijNFNpbG0vL588cNzpLC4I00cnCD1fPBuVqffbA5DMGNjR5MOSBpC+UYxGE5G5PmNXff/vy4rdnTmRJHD1wG+9G42D9qVfeePLk/oONI8qv7+/2fbq11f53ZfnqhStLi6d3b67/cT/+vwAAAP//Xo5dwOtdLi4AAAAASUVORK5CYII="></a>
+      <a href="https://github.com/astral-sh/uv"><img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" style="max-width:100%;"></a>
+      <a href="https://github.com/astral-sh/ruff"><img alt="ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" style="max-width:100%;"></a>
+      <a href="https://github.com/tox-dev/pipdeptree"><img alt="pipdeptree" src="https://img.shields.io/badge/pipdeptree-526CFE.svg?labelColor=gray&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAADFElEQVR4nFxTW2tcVRRe39773E/mliZjwKRmhBaKt4BWRKmGgihCH3xUKNWC/Q/ii76IP8AHpSIiRfqmD5YKCinalhgiCMZLSVtMM0mTdDLTuZyZc9l7yTlp7WXBgXPW+fa31rfWtxU9FLMN79Crr028e+iJsZfb7fJMp23xRlOvbTR3L/y5cuOL3Vbv7/vxuPviecI/eWr6k/mj4+8AkM11y+zs2MKwMJvNgIgYINZX/rlx+tIvf72fZXr4P0EQyOCjjw98P9vwn8+/+z3Bq6sek7AJkNhsOjQcyjvFmHd2upd+PP/zsSxNI5mnPvjw8U9fPFJ9XVkgNuDVayEbcgVEfgikNfFg4JAmh1LyyfGq06QqE9vN6+fEs4fHnjv25vjbAOA4AsL2MVZ1hRcI4QXIH7ilMqQXkiYXRBJRbFNQnTsRlqfmxFvH66ccFyAQMxP3I5cqNZBSxIWcKORMO9g3yeSHzFkGbnVCIkDUZ+beEy+8VJ4XguC6TMPYokwrCAHUJsBxYptoFBYSMi0oLIlcAkuFYhal8Zl5VanZU0zErgfurufMFjEkWZ7iRFY4SlgYfW9bUIJKFQNjiNPYf1QZOZn/hTaStPQKTI4eDCxSjsL4I6BeJzOjgcnT0HqPqwBJCdHZjW/miWjkkG3hzqKIe5FVlM3llGuWqOxTDMBkWlJ/6PB2p0Sb21gXixdvLeTtDGOHLFvQHpkiYyTuNU5kuxJercTdpEK3Bz4yLdFrXVsQ33x1/bModjhvyrKKVXB/YD9gb8PgKAlolAZipmFTOIYcxq21Xz8XS5dbi+e+2zqbA3MjxYninH3PpkyZljwYjZE2FoxBIWm6YVHaW/k66qwtF05curz509OHHzvqBqWp232fE+2AoCjOXNMfhcRcjAxxoijNFNpbG0vL588cNzpLC4I00cnCD1fPBuVqffbA5DMGNjR5MOSBpC+UYxGE5G5PmNXff/vy4rdnTmRJHD1wG+9G42D9qVfeePLk/oONI8qv7+/2fbq11f53ZfnqhStLi6d3b67/cT/+vwAAAP//Xo5dwOtdLi4AAAAASUVORK5CYII="></a>
+      <a href="https://squidfunk.github.io/mkdocs-material/"><img alt="mkdocs-material" src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?&logo=MaterialForMkDocs&logoColor=white&labelColor=grey"></a>
+      <a href="https://hatch.pypa.io"><img alt="Hatch project" class="off-glb" loading="lazy" src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg"></a>
     </td>
   </tr>
-  <tr style="vertical-align: middle; border-width: 0;">
+  <tr style="vertical-align: middle;">
     <td>CI/CD</td>
     <td>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master"></a>
+      <a href="https://github.com/erivlis/graphinate/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/erivlis/graphinate/actions/workflows/test-beta.yml/badge.svg?branch=master"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish.yml"><img alt="Publish" src="https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg"></a>
       <a href="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml"><img alt="Publish Docs" src="https://github.com/erivlis/graphinate/actions/workflows/publish-docs.yaml/badge.svg"></a>
     </td>
   </tr>
-  <tr style="vertical-align: middle; border-width: 0;">
+  <tr style="vertical-align: middle;">
     <td>Scans</td>
     <td>
       <a href="https://codecov.io/gh/erivlis/graphinate"><img alt="Coverage" src="https://codecov.io/gh/erivlis/graphinate/graph/badge.svg?token=POODT8M9NV"/></a>
-      <br>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Quality Gate Status" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=alert_status"></a>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Security Rating" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=security_rating"></a>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Maintainability Rating" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=sqale_rating"></a>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Reliability Rating" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=reliability_rating"></a>
-      <br>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Lines of Code" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=ncloc"></a>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Vulnerabilities" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=vulnerabilities"></a>
       <a href="https://sonarcloud.io/summary/new_code?id=erivlis_graphinate"><img alt="Bugs" src="https://sonarcloud.io/api/project_badges/measure?project=erivlis_graphinate&metric=bugs"></a>
-      <br>
       <a href="https://app.codacy.com/gh/erivlis/graphinate/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img alt="Codacy Badge" src="https://app.codacy.com/project/badge/Grade/54b33c3f7313448f9471d01e2a06f037"></a>
       <a href="https://app.codacy.com/gh/erivlis/graphinate/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage"><img alt="Codacy Coverage" src="https://app.codacy.com/project/badge/Coverage/54b33c3f7313448f9471d01e2a06f037"/></a>
       <a href="https://scrutinizer-ci.com/g/erivlis/graphinate"><img alt="Scrutinizer" src="https://scrutinizer-ci.com/g/erivlis/graphinate/badges/quality-score.png?b=main"></a>
+      <a href="https://www.codefactor.io/repository/github/erivlis/graphinate"><img src="https://www.codefactor.io/repository/github/erivlis/graphinate/badge" alt="CodeFactor" /></a>
+      <a href="https://snyk.io/test/github/erivlis/graphinate"><img alt="Snyk" src="https://snyk.io/test/github/erivlis/Graphinate/badge.svg"></a>
     </td>
   </tr>
 </table>

{graphinate-0.3.2 → graphinate-0.5.0}/docs/intro.md

@@ -4,14 +4,14 @@
 
 ### What is Graphinate?
 
-**Graphinate** is a python library that aims to simplify the generation of Graph Data Structures from Data Sources.
+**Graphinate** is a python library that can be used to generate 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/).
+**Graphinate** uses and is built upon the excellent [**_NetworkX_**](https://networkx.org/).
 
 ### What is a Graph?
 
@@ -35,10 +35,9 @@ formally.”
 
 ### 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.
+A Graph can be a 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 any data source that has structure.
 
 ### Graph Elements
 
@@ -47,14 +46,14 @@ 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.).  
+in particular when the node in itself has no specific meaning.
+One can also add attributes to the node to describe additional information. This information can be anything.
+Often attributes 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. 
+A Graph Edge is a pair of two node values. It can also have additional attributes in the same vain as a Graph Node.
 
 ### Defining a Graph
 
@@ -62,13 +61,14 @@ 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.
+The most straightforward way to generate a Graph is to supply a list of edges. The simplest definition of an edge is a
+pair 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, such as weight, direction, etc.
 
 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.
+Such a graph is focused more on the _relationships_ between nodes, or the _structure_ of the graph,
+than on the nodes themselves.
 
 #### Node First
 
@@ -78,33 +78,34 @@ 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.
+Such a graph may have a focus primarily on the nodes, and then only if needed on the relationship between them.
 
-### Graphinate 
+### Graphinate
 
-"Hydrate" a Graph from a Data Source.
-Using Graphinate enables generating graphs from data sources.
+Graphinate helps to generate graphs from data sources ("Hydrate" a Graph from a Data Source.)
 It supports both *Edge First* and *Node First* creation scenarios.
 
-This is achieved following these steps: 
+This is achieved the following way:
 
-#### Source 
+#### Source
 
-It is required to represent the Data sources as an Iterable of items that will be transformed to graph edges
+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.
+It is recommended to use Generators as the items Iterables. This way, the data source can be lazy-loaded.
+The Iterables or Generators can be anything, from a simple list of dictionaries to a complex database query.
 
 #### Model
 
-Using Graphinate GraphMode decorators, we can define how to transform the items supplied by the data source generators,
-to graph elements.
+Graphinate introduces the concept of a Graph Model.
+A Graph Model is a set of rules, that define how to transform the data source item into Graph elements (i.e. nodes and
+edges). The GraphModel registers the sources using node and edge decorators.
 
 #### 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.
+
+A Graph Model can be used to generate an actual instance of a Graph that contains the transformed source data.
+Graphinate provides several GraphBuilder classes, that can be used to build the Graph from the Graph Model.
 
 #### 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.) 
+Finally, we can use the builders to Materialize the graph in several ways that support different use cases
+(i.e., visualizing, querying, reporting, etc.).