Graphinate 0.8.0__tar.gz → 0.8.1__tar.gz

graphinate-0.8.1/.coveragerc

@@ -0,0 +1,3 @@
+[run]
+branch = True
+relative_files = True

{graphinate-0.8.0 → graphinate-0.8.1}/.github/workflows/publish-docs.yaml

@@ -25,5 +25,5 @@ jobs:
           pip install uv
           uv venv
           source .venv/bin/activate
-          uv pip install mkdocs-material mkdocstrings-python mkdocs-git-revision-date-localized-plugin mkdocs-gen-files mkdocs-glightbox mkdocs-literate-nav mkdocs-section-index
+          uv pip install mkdocs-material mkdocstrings-python mkdocs-git-committers-plugin-2 "mkdocs-git-revision-date-localized-plugin<1.4.0" mkdocs-gen-files mkdocs-glightbox mkdocs-literate-nav mkdocs-section-index
           mkdocs gh-deploy --force

{graphinate-0.8.0 → graphinate-0.8.1}/.github/workflows/test.yml

@@ -38,11 +38,16 @@ jobs:
       - name: Test with pytest
         run: |
           python -m pip install faker pytest pytest-asyncio pytest-cov pytest-randomly pytest-xdist starlette-prometheus uvicorn[standard]
-          pytest tests --cov=src --cov-branch --cov-report=xml --junitxml=test_results.xml -n auto
+          pytest tests --cov=src --cov-branch --cov-report=xml --junitxml=junit.xml -o junit_family=legacy -n auto
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
       - name: Run codacy-coverage-reporter
         uses: codacy/codacy-coverage-reporter-action@v1.3.0
         with:

{graphinate-0.8.0 → graphinate-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Graphinate
-Version: 0.8.0
+Version: 0.8.1
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
@@ -122,34 +122,34 @@ Description-Content-Type: text/markdown
 ## Table of Contents
 
 - [Introduction](#introduction)
-    - [What is Graphinate?](#what-is-graphinate)
-    - [Links](#links)
+  - [What is Graphinate?](#what-is-graphinate)
+  - [Links](#links)
 - [Quick Start](#quick-start)
-    - [Install](#install)
-    - [Example](#example)
+  - [Install](#install)
+  - [Example](#example)
 - [CLI](#cli)
-    - [Commands](#commands)
-        - [Save](#save)
-        - [Server](#server)
+  - [Commands](#commands)
+    - [Save](#save)
+    - [Server](#server)
 - [Gallery](#gallery)
-    - [Python AST](#python-ast)
-    - [GitHub Repository](#github-repository)
-    - [Python AST - 3D Force-Directed Animation](#python-ast---3d-force-directed-animation)
-    - [Web Page Links](#web-page-links)
+  - [Python AST](#python-ast)
+  - [GitHub Repository](#github-repository)
+  - [Python AST - 3D Force-Directed Animation](#python-ast---3d-force-directed-animation)
+  - [Web Page Links](#web-page-links)
 - [Development](#development)
-    - [Ruff](#ruff)
-    - [Test](#test)
-        - [Standard (cobertura) XML Coverage Report](#standard-cobertura-xml-coverage-report)
-        - [HTML Coverage Report](#html-coverage-report)
-    - [Docs](#docs)
-        - [test](#test-1)
-        - [build](#build)
+  - [Ruff](#ruff)
+  - [Test](#test)
+    - [Standard (cobertura) XML Coverage Report](#standard-cobertura-xml-coverage-report)
+    - [HTML Coverage Report](#html-coverage-report)
+  - [Docs](#docs)
+    - [test](#test-1)
+    - [build](#build)
 - [Acknowledgements](#acknowledgements)
-    - [Dependencies](#dependencies)
-        - [Python](#python)
-        - [Javascript and HTML](#javascript-and-html)
-    - [Dev Tools](#dev-tools)
-    - [IDE](#ide)
+  - [Dependencies](#dependencies)
+    - [Python](#python)
+    - [Javascript and HTML](#javascript-and-html)
+  - [Dev Tools](#dev-tools)
+  - [IDE](#ide)
 
 ## Introduction
 
@@ -191,16 +191,15 @@ pip install graphinate[server]
 ### Example
 
 ```python title="Octagonal Graph"
-import examples.math.materializers
 import graphinate
 
 N: int = 8
 
-# Define a GraphModel
+# First Define a GraphModel instance.
+# It will be used to hold the graph definitions
 graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")
 
-
-# Register in the Graph Model the edges' supplier function
+# Register in the Graph Model the edges' supplier generator function
 @graph_model.edge()
 def edge():
     for i in range(N):
@@ -208,25 +207,35 @@ def edge():
     yield {'source': N, 'target': 0}
 
 
-# Choose builder and handler
-builder, handler = examples.math.materializers.Materializers.NetworkX_with_edge_labels.value
-
 # Use the NetworkX Builder
 builder = graphinate.builders.NetworkxBuilder(graph_model)
 
-# build the NetworkX graph
+# build the NetworkX GraphRepresentation
+# the output in this case is a nx.Graph instance
 graph = builder.build()
 
-# plot the graph using matplotlib
-graphinate.plot(graph, with_edge_labels=True)
-```
+# this supplied plot method uses matplotlib to display the graph
+graphinate.matplotlib.plot(graph, with_edge_labels=True)
+
+# or use the Mermaid Builder
+builder = graphinate.builders.MermaidBuilder(graph_model)
 
-#### `graphinate.model` function
+# to create a Mermaid diagram
+diagram: str = builder.build()
 
-> [!NOTE]
-> This function creates `GraphModel` class that is used to declaratively register _Edge_ and/or _Node_ data
-> supplier functions by using the `GraphModel.node()` and `GraphModel.edge()` decorators.
+# and get Markdown or single page HTML to display it
+mermaid_markdown: str = graphinate.mermaid.markdown(diagram)
+mermaid_html: str = graphinate.mermaid.html(diagram, title=graph_model.name)
 
+# or use the GraphQL Builder
+builder = graphinate.builders.GraphQLBuilder(graph_model)
+
+# to create a Strawberry GraphQL schema
+schema = builder.build()
+
+# and serve it using Uvicorn web server
+graphinate.graphql.server(schema)
+```
 ## CLI
 
 ### Commands
@@ -273,21 +282,24 @@ Options:
 
 ## Gallery
 
-### Python AST
+### Python Class AST
 
-![d3_graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
+#### matplotlib
 
-### GitHub Repository
+![graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
 
-![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
-
-### Python AST - 3D Force-Directed Animation
+#### 3D Force-Directed Animation
 
 <video width="400"  controls>
   <source src="https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b" type="video/mp4">
 </video>
 
-### Web Page Links
+### GitHub Repository
+
+![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
+
+
+### Web Links
 
 ![Web Page Links](https://github.com/erivlis/graphinate/assets/9897520/ea5b00a2-75d1-4d0e-86af-272f20973149)
 
@@ -327,19 +339,19 @@ ruff check src --fix
 #### Standard (cobertura) XML Coverage Report
 
 ```shell
- python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=test_results.xml
+ python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=junit.xml
 ```
 
 #### HTML Coverage Report
 
 ```shell
-python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=test_results.xml
+python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=junit.xml
 ```
 
 #### Terminal Coverage Report
 
 ```shell
-python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=test_results.xml
+python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=junit.xml
 ```
 
 ### Docs
@@ -384,7 +396,7 @@ python -m mkdocs build
 
 ### IDE
 
-<a href="https://www.jetbrains.com/pycharm/"><img height="60" style="background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo"></a>
+<a href="https://www.jetbrains.com/pycharm/"><img height="60" style="padding: 5px; background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo"></a>
 
 --------------------------------
 
@@ -392,6 +404,6 @@ python -m mkdocs build
 
 --------------------------------
 
-<img alt="Star Chart" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
+<img alt="Work on my Machine" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
 
 Copyright © 2023-2025 Eran Rivlis

{graphinate-0.8.0 → graphinate-0.8.1}/README.md

@@ -78,34 +78,34 @@
 ## Table of Contents
 
 - [Introduction](#introduction)
-    - [What is Graphinate?](#what-is-graphinate)
-    - [Links](#links)
+  - [What is Graphinate?](#what-is-graphinate)
+  - [Links](#links)
 - [Quick Start](#quick-start)
-    - [Install](#install)
-    - [Example](#example)
+  - [Install](#install)
+  - [Example](#example)
 - [CLI](#cli)
-    - [Commands](#commands)
-        - [Save](#save)
-        - [Server](#server)
+  - [Commands](#commands)
+    - [Save](#save)
+    - [Server](#server)
 - [Gallery](#gallery)
-    - [Python AST](#python-ast)
-    - [GitHub Repository](#github-repository)
-    - [Python AST - 3D Force-Directed Animation](#python-ast---3d-force-directed-animation)
-    - [Web Page Links](#web-page-links)
+  - [Python AST](#python-ast)
+  - [GitHub Repository](#github-repository)
+  - [Python AST - 3D Force-Directed Animation](#python-ast---3d-force-directed-animation)
+  - [Web Page Links](#web-page-links)
 - [Development](#development)
-    - [Ruff](#ruff)
-    - [Test](#test)
-        - [Standard (cobertura) XML Coverage Report](#standard-cobertura-xml-coverage-report)
-        - [HTML Coverage Report](#html-coverage-report)
-    - [Docs](#docs)
-        - [test](#test-1)
-        - [build](#build)
+  - [Ruff](#ruff)
+  - [Test](#test)
+    - [Standard (cobertura) XML Coverage Report](#standard-cobertura-xml-coverage-report)
+    - [HTML Coverage Report](#html-coverage-report)
+  - [Docs](#docs)
+    - [test](#test-1)
+    - [build](#build)
 - [Acknowledgements](#acknowledgements)
-    - [Dependencies](#dependencies)
-        - [Python](#python)
-        - [Javascript and HTML](#javascript-and-html)
-    - [Dev Tools](#dev-tools)
-    - [IDE](#ide)
+  - [Dependencies](#dependencies)
+    - [Python](#python)
+    - [Javascript and HTML](#javascript-and-html)
+  - [Dev Tools](#dev-tools)
+  - [IDE](#ide)
 
 ## Introduction
 
@@ -147,16 +147,15 @@ pip install graphinate[server]
 ### Example
 
 ```python title="Octagonal Graph"
-import examples.math.materializers
 import graphinate
 
 N: int = 8
 
-# Define a GraphModel
+# First Define a GraphModel instance.
+# It will be used to hold the graph definitions
 graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")
 
-
-# Register in the Graph Model the edges' supplier function
+# Register in the Graph Model the edges' supplier generator function
 @graph_model.edge()
 def edge():
     for i in range(N):
@@ -164,25 +163,35 @@ def edge():
     yield {'source': N, 'target': 0}
 
 
-# Choose builder and handler
-builder, handler = examples.math.materializers.Materializers.NetworkX_with_edge_labels.value
-
 # Use the NetworkX Builder
 builder = graphinate.builders.NetworkxBuilder(graph_model)
 
-# build the NetworkX graph
+# build the NetworkX GraphRepresentation
+# the output in this case is a nx.Graph instance
 graph = builder.build()
 
-# plot the graph using matplotlib
-graphinate.plot(graph, with_edge_labels=True)
-```
+# this supplied plot method uses matplotlib to display the graph
+graphinate.matplotlib.plot(graph, with_edge_labels=True)
+
+# or use the Mermaid Builder
+builder = graphinate.builders.MermaidBuilder(graph_model)
 
-#### `graphinate.model` function
+# to create a Mermaid diagram
+diagram: str = builder.build()
 
-> [!NOTE]
-> This function creates `GraphModel` class that is used to declaratively register _Edge_ and/or _Node_ data
-> supplier functions by using the `GraphModel.node()` and `GraphModel.edge()` decorators.
+# and get Markdown or single page HTML to display it
+mermaid_markdown: str = graphinate.mermaid.markdown(diagram)
+mermaid_html: str = graphinate.mermaid.html(diagram, title=graph_model.name)
 
+# or use the GraphQL Builder
+builder = graphinate.builders.GraphQLBuilder(graph_model)
+
+# to create a Strawberry GraphQL schema
+schema = builder.build()
+
+# and serve it using Uvicorn web server
+graphinate.graphql.server(schema)
+```
 ## CLI
 
 ### Commands
@@ -229,21 +238,24 @@ Options:
 
 ## Gallery
 
-### Python AST
+### Python Class AST
 
-![d3_graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
+#### matplotlib
 
-### GitHub Repository
+![graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
 
-![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
-
-### Python AST - 3D Force-Directed Animation
+#### 3D Force-Directed Animation
 
 <video width="400"  controls>
   <source src="https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b" type="video/mp4">
 </video>
 
-### Web Page Links
+### GitHub Repository
+
+![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
+
+
+### Web Links
 
 ![Web Page Links](https://github.com/erivlis/graphinate/assets/9897520/ea5b00a2-75d1-4d0e-86af-272f20973149)
 
@@ -283,19 +295,19 @@ ruff check src --fix
 #### Standard (cobertura) XML Coverage Report
 
 ```shell
- python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=test_results.xml
+ python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=junit.xml
 ```
 
 #### HTML Coverage Report
 
 ```shell
-python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=test_results.xml
+python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=junit.xml
 ```
 
 #### Terminal Coverage Report
 
 ```shell
-python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=test_results.xml
+python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=junit.xml
 ```
 
 ### Docs
@@ -340,7 +352,7 @@ python -m mkdocs build
 
 ### IDE
 
-<a href="https://www.jetbrains.com/pycharm/"><img height="60" style="background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo"></a>
+<a href="https://www.jetbrains.com/pycharm/"><img height="60" style="padding: 5px; background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo"></a>
 
 --------------------------------
 
@@ -348,6 +360,6 @@ python -m mkdocs build
 
 --------------------------------
 
-<img alt="Star Chart" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
+<img alt="Work on my Machine" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
 
 Copyright © 2023-2025 Eran Rivlis

{graphinate-0.8.0 → graphinate-0.8.1}/docs/.dates_cache.json

@@ -1,23 +1,23 @@
 {
   "acknowledge.md": {
     "created": "2023-08-20T00:21:55.621436",
-    "modified": "2024-07-23T19:55:37.245608"
+    "modified": "2025-03-12T00:39:57.859235"
   },
   "index.md": {
     "created": "2023-08-15T00:05:21.586874",
-    "modified": "2025-03-08T22:16:20.899386"
+    "modified": "2025-03-12T00:40:46.459147"
   },
   "intro.md": {
     "created": "2023-08-19T23:54:18.668094",
-    "modified": "2025-03-07T10:45:53.488431"
+    "modified": "2025-03-11T23:24:02.836144"
   },
   "start.md": {
     "created": "2023-08-20T00:07:42.683716",
-    "modified": "2025-03-02T01:05:03.715683"
+    "modified": "2025-03-11T23:45:05.567864"
   },
   "tutorial.md": {
     "created": "2025-02-26T00:03:30.194156",
-    "modified": "2025-03-07T12:16:22.526422"
+    "modified": "2025-03-12T00:12:38.290310"
   },
   "examples\\code.md": {
     "created": "2023-08-20T00:09:32.677003",
@@ -33,7 +33,7 @@
   },
   "examples\\social.md": {
     "created": "2025-02-24T23:49:35.972953",
-    "modified": "2025-02-24T23:51:09.584738"
+    "modified": "2025-03-11T23:47:36.266891"
   },
   "examples\\system.md": {
     "created": "2024-03-27T01:28:38.922865",
@@ -41,7 +41,7 @@
   },
   "examples\\web.md": {
     "created": "2023-10-05T11:43:30.550657",
-    "modified": "2025-03-07T10:25:30.054257"
+    "modified": "2025-03-12T00:42:43.742512"
   },
   "reference\\SUMMARY.md": {
     "created": "2025-03-08T20:51:52.801367",
@@ -53,7 +53,7 @@
   },
   "usage\\lib.md": {
     "created": "2023-09-27T21:23:44.133584",
-    "modified": "2025-03-07T12:07:02.708943"
+    "modified": "2025-03-12T00:30:12.961397"
   },
   "reference\\graphinate\\builders.md": {
     "created": "2025-03-08T20:51:52.788270",

{graphinate-0.8.0 → graphinate-0.8.1}/docs/acknowledge.md

@@ -14,15 +14,18 @@
 
 <a href="https://vasturiano.github.io/3d-force-graph/"><img style="height: 50px; padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="http://gist.github.com/vasturiano/02affe306ce445e423f992faeea13521/raw/preview.png" alt="3D Force-Directed Graph Logo."></a>
 <a href="https://github.com/graphql-kit/graphql-voyager"><img style="height: 50px; padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/graphql-kit/graphql-voyager/raw/main/docs/cover.png" alt="Graphql Voyager Logo."></a>
+<a href="https://github.com/cocopon/tweakpane"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://user-images.githubusercontent.com/602961/184479032-38f50be3-e235-4914-85c0-dce316b33ed2.png" alt="Tweakpane Logo"></a>
 
 ## Dev Tools
 
-<a href="https://hatch.pypa.io/"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://hatch.pypa.io/latest/assets/images/logo.svg" alt="Hatch logo."></a>
-<a href="https://squidfunk.github.io/mkdocs-material/"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" alt="Material for MkDocs"></a>
-<a href="https://pytest.org"><img  style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://docs.pytest.org/en/7.4.x/_static/pytest_logo_curves.svg" alt="pytest logo."></a>
-<a href="https://astral.sh/ruff"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://astralcms.wpengine.com/wp-content/uploads/2023/03/Ruff-Logo.svg" alt="Ruff logo."></a>
 <a href="https://astral.sh/uv"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://avatars.githubusercontent.com/u/115962839" alt="uv logo."></a>
+<a href="https://astral.sh/ruff"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://astralcms.wpengine.com/wp-content/uploads/2023/03/Ruff-Logo.svg" alt="Ruff logo."></a>
+<a href="https://squidfunk.github.io/mkdocs-material/"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" alt="Material for MkDocs"></a>
+<a href="https://pytest.org"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://docs.pytest.org/en/7.4.x/_static/pytest_logo_curves.svg" alt="pytest logo."></a>
+<a href="https://hatch.pypa.io/"><img style="height: 50px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://hatch.pypa.io/latest/assets/images/logo.svg" alt="Hatch logo."></a>
+
+
 
 ## IDE
 
-<a href="https://www.jetbrains.com/pycharm/"><img style="height: 50px; background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo."></a>
+<a href="https://www.jetbrains.com/pycharm/"><img style="height: 50px; padding: 5px; background: linear-gradient(-45deg, #FCF84A, #3DEA62, #21D789);" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PyCharm.png" alt="PyCharm logo."></a>

graphinate-0.8.1/docs/examples/social.md

@@ -0,0 +1,15 @@
+# Social
+
+## Music Artists
+
+=== "Music Artists"
+
+    ``` python title="examples/social/music_artists.py" linenums="1"
+    --8<-- "examples/social/music_artists.py"
+    ```
+
+=== "Dependencies"
+
+    ``` text title="examples/social/requirements.txt" linenums="1"
+    --8<-- "examples/social/requirements.txt"
+    ```

{graphinate-0.8.0 → graphinate-0.8.1}/docs/examples/web.md

@@ -25,7 +25,7 @@
 === "HTML DOM"
 
     ``` python title="examples/web/html_dom.py" linenums="1"
-    --8<-- "examples/web/html_page_dom.py"
+    --8<-- "examples/web/html_dom.py"
     ```
 
 === "Dependencies"

graphinate-0.8.1/docs/index.md

@@ -0,0 +1,4 @@
+# Graphinate. Data to Graphs.
+
+<img style="width: 360px;" src="https://github.com/erivlis/graphinate/assets/9897520/dae41f9f-69e5-4eb5-a488-87ce7f51fa32" alt="Graphinate. Data to Graphs.">
+

{graphinate-0.8.0 → graphinate-0.8.1}/docs/intro.md

@@ -4,28 +4,17 @@
 
 ### Why Graphs?
 
-Graphs are a powerful data structure that can be used to model a wide range of problems.
-They are used in many fields, such as computer science, mathematics, physics, biology, and social sciences.
+A Graph is a powerful data structure, that can be used to model a wide range of problems.
+Graphs are used in many fields, such as computer science, mathematics, physics, biology, social sciences and more.
 
 ### Why Graphinate?
 
-Usually the creation phase of a Graph is a tedious and error-prone process.
+Usually the creation of a Graph is a tedious and error-prone process.
 It requires a lot of boilerplate code to transform data into a Graph.
 This process can be automated and simplified. This is where **Graphinate** comes in.
 
 ## What?
 
-### What is Graphinate?
-
-**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** uses and is built upon the excellent [**_NetworkX_**](https://networkx.org/).
-
 ### What is a Graph?
 
 !!! quote
@@ -48,6 +37,17 @@ In addition, there are several modes of output to enable examination of the Grap
    
     — [https://en.wikipedia.org/wiki/Data](https://en.wikipedia.org/wiki/Data)
 
+### What is Graphinate?
+
+**Graphinate** is a python library that helps generate and populate 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.
+
+There are several modes of building and rendering to facilitate examination of the Graph and its content.
+
+**Graphinate** uses and is built upon the excellent [**_NetworkX_**](https://networkx.org/).
+
 ## How?
 
 ### A Graph as a Data Structure
@@ -104,30 +104,37 @@ Such a graph may have a focus primarily on the nodes, and then only if needed on
 
 ### Graphinate
 
-Graphinate helps to generate graphs from data sources ("Hydrate" a Graph from a Data Source.)
+Graphinate helps to generate graphs from data sources ("Hydrate" a Graph Model from a Data Source.)
 It supports both *Edge First* and *Node First* creation scenarios.
 
 This is achieved the following way:
 
 #### 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. 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.
+First, it is required to represent the data sources, as an `Iterable` of items.
+It will be supply the data items that will be used to create the graph edges and/or nodes.
+It is recommended to use a `Generator`  as the items Iterable. This way, the data source can be
+lazily-loaded.
+Such an `Iterable` or `Generator` can be, anything from a simple list of dictionaries, to a complex database query.
 
 #### Model
 
-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.
+Graphinate introduces the concept of a `GraphModel`.
+A GraphModel embodies a set of rules which define how to use a data source item in creating a Graph element (i.e.,
+either a node or an edges). The `GraphModel` registers the sources using `GraphModel.node` and `GraphModel.edge`
+decorators. These decorators define how to extract both mandatory and optional aspects of information, which then are
+used to generate each Graph element.
 
-#### Build
+#### Builders
 
-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.
+A `GraphModel` can be used to generate an actual instance of a `GraphRepresentation`.
+Such a `GraphRepresentation` will contain the actual Graph data structure, populated with the data items obtained from
+the source.
+Graphinate provides several `GraphBuilder` classes that can be used to build the `GraphRepresentation` from
+a `GraphModel`. The actual nature of the `GraphRepresentation` will depend on the `GraphBuilder` used.
 
-#### Materialize
+#### Renderers
 
-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 render a builder's output `GraphRepresentation`. The Renderers chosen depends on the actual type of the
+`GraphRepresentaion` and the desired rendering output format. Graphinate provides several Renderer classes that can be
+used for different use cases such as visualizing, querying, reporting, etc.