Graphinate 0.0.8__tar.gz → 0.0.9__tar.gz

{graphinate-0.0.8 → graphinate-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Graphinate
-Version: 0.0.8
+Version: 0.0.9
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://github.com/erivlis/graphinate
 Project-URL: Documentation, https://github.com/erivlis/graphinate#README.md
@@ -35,7 +35,6 @@ Requires-Dist: strawberry-graphql[asgi,opentelemetry]
 Provides-Extra: dev
 Requires-Dist: ruff; extra == 'dev'
 Provides-Extra: plot
-Requires-Dist: matplotlib; extra == 'plot'
 Requires-Dist: scipy; extra == 'plot'
 Provides-Extra: server
 Requires-Dist: starlette-prometheus; extra == 'server'
@@ -47,9 +46,10 @@ Description-Content-Type: text/markdown
 
 # Graphinate. Data to Graphs.
 
-## ⚠️ **Under Development!** ⚠️
-
-This library is alpha-quality
+> [!WARNING]
+> **UNDER DEVELOPMENT**
+> 
+> **This library is alpha-quality**
 
 ![PyPI](https://img.shields.io/pypi/v/graphinate)
 ![PyPI - Status](https://img.shields.io/pypi/status/graphinate)
@@ -63,98 +63,70 @@ This library is alpha-quality
 [![Tests](https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/erivlis/graphinate/actions/workflows/test.yml)
 [![Publish](https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg)](https://github.com/erivlis/graphinate/actions/workflows/publish.yml)
 
-## Install
-
-Graphinate is available on PyPI:
-
-```shell
-python -m pip install graphinate 
-```
-
-Graphinate officially supports Python 3.9+.
-
 ## Introduction
 
 ### What is Graphinate?
 
-Graphinate aims to simplify the generation of Graph data structures from sources of data.
-It utilizes and build upon [NetworkX](https://networkx.org/)
+Graphinate is a library that aims to simplify the generation of Graph Data Structures from Data Sources.
 
-### What is a Graph?
+It utilizes and builds upon the excellent [**_NetworkX_**](https://networkx.org/) library.
 
-> 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)
+In addition, it has several interfaces for ease of use:
 
-### What is Data?
+- CLI (using [**_Click_**](https://palletsprojects.com/p/click/)),
+- GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
 
-> ...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)
+[//]: # (- TUI (using [**_Textual_**](https://textual.textualize.io/)) **⚠️Not available yet⚠️**)
 
-### Defining a Graph
+## Install
 
-One can define Graphs in two general ways:
+Graphinate is available on PyPI:
 
-#### Edge first
+```shell
+pip install graphinate
+```
 
-Generate a Graph by supplying a list of edges. The simplest definition of an edge will be a tuple of 2 values. Each
-value represent a node (or vertex) in the graph. Additional attributes may be also added to the edge definition to
-signify additional meaning.
+To install with server support
 
-In this case one defines the **edges explicitly** and the **nodes implicitly**.
+```shell
+pip install graphinate[server]
+```
 
-Such graph is focused more on the _relationships_ or the _structure_ of the Graph than on the nodes themselves.
+Graphinate officially supports Python 3.9+.
 
-#### Node first
+## Quick Start
 
-Alternatively, one can first add nodes (vertices) to a graph without defining edges. Additional attributes may be added
-to the node definition to signify additional meaning. Later on edge definitions are added to generate the relationships
-between the nodes.
+### `GraphModel`
 
-In this case **both nodes and the edges** are defines **explicitly**.
+Graphinate defines the `GraphModel` Class which can be used to declaratively register _Edge_ and/or _Node_ data
+supplier functions by using decorators.
 
-Such a graph has focus first on the nodes and later on the relationship between them.
+### `materialize`
 
-## Gallery
+Graphinate supplies a `materialize` function to output the `GraphModel`.
 
-![d3_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)
-![AST 3D Force animation](https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b)
+### Example
 
-## Examples
+```python
+import graphinate
 
-- [ ] Code
-  - [ ] Call Graph
-  - [x] Python AST
-- [x] GitHub
-  - [x] Repository
-  - [x] Followers
-- [ ] Ethernet
-  - [ ] Traceroute
-- [ ] Math
-  - [x] Graph Atlas
-  - [ ] Hailstone
-- [ ] Text
-  - [ ] NLP
-- [ ] Web
-  - [ ] Web Graph
+N: int = 8
 
-## Guide
+# Define GraphModel
+graph_model = graphinate.GraphModel(name="Octagonal Graph")
 
-### By Convention
 
-https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/followers.py#L1
+# Register edges supplier function
+@graph_model.edge()
+def edge():
+    for i in range(N):
+        yield {'source': i, 'target': i + 1}
+    yield {'source': N, 'target': 0}
 
-### By Configuration
 
-https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/repositories.py#L1
+# Materialize the GraphModel
+graphinate.materialize(graph_model)
+```
 
 ## CLI
 
@@ -190,6 +162,24 @@ Options:
   --help              Show this message and exit.
 ```
 
+## TUI
+
+UNDER DEVELOPMENT
+
+## Gallery
+
+### Python AST
+
+![d3_graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
+
+### GitHub Repository
+
+![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
+
+### Python AST - 3D Force-Directed Animation
+
+![AST 3D Force animation](https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b)
+
 ## Development
 
 ### Lint
@@ -220,13 +210,19 @@ python -m build
 
 ### Dependencies
 
-<a href="https://vasturiano.github.io/3d-force-graph/"><img height="50" style="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>
+#### Python
+
 <a href="https://palletsprojects.com/p/click/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://click.palletsprojects.com/en/7.x/_images/click-logo.png" alt="Click Logo."></a>
 <a href="https://github.com/Delgan/loguru"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://raw.githubusercontent.com/Delgan/loguru/master/docs/_static/img/logo.png" alt="Loguru Logo."></a>
 <a href="https://matplotlib.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://matplotlib.org/_static/logo_dark.svg" alt="matplotlib Logo."></a>
 <a href="https://networkx.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://networkx.org/_static/networkx_logo.svg" alt="NetworkX Logo."></a>
 <a href="https://strawberry.rocks/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/strawberry-graphql/strawberry/raw/main/.github/logo.png" alt="Strawberry GraphQL Logo."></a>
 
+#### Javascript and HTML
+
+<a href="https://vasturiano.github.io/3d-force-graph/"><img height="50" style="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 height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/graphql-kit/graphql-voyager/raw/main/docs/cover.png" alt="Graphql Voyager Logo."></a>
+
 ### Dev Tools
 
 <a href="https://hatch.pypa.io/"><img height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://hatch.pypa.io/latest/assets/images/logo.svg" alt="Hatch logo."></a>

{graphinate-0.0.8 → graphinate-0.0.9}/README.md

@@ -1,8 +1,9 @@
 # Graphinate. Data to Graphs.
 
-## ⚠️ **Under Development!** ⚠️
-
-This library is alpha-quality
+> [!WARNING]
+> **UNDER DEVELOPMENT**
+> 
+> **This library is alpha-quality**
 
 ![PyPI](https://img.shields.io/pypi/v/graphinate)
 ![PyPI - Status](https://img.shields.io/pypi/status/graphinate)
@@ -16,98 +17,70 @@ This library is alpha-quality
 [![Tests](https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/erivlis/graphinate/actions/workflows/test.yml)
 [![Publish](https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg)](https://github.com/erivlis/graphinate/actions/workflows/publish.yml)
 
-## Install
-
-Graphinate is available on PyPI:
-
-```shell
-python -m pip install graphinate 
-```
-
-Graphinate officially supports Python 3.9+.
-
 ## Introduction
 
 ### What is Graphinate?
 
-Graphinate aims to simplify the generation of Graph data structures from sources of data.
-It utilizes and build upon [NetworkX](https://networkx.org/)
+Graphinate is a library that aims to simplify the generation of Graph Data Structures from Data Sources.
 
-### What is a Graph?
+It utilizes and builds upon the excellent [**_NetworkX_**](https://networkx.org/) library.
 
-> 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)
+In addition, it has several interfaces for ease of use:
 
-### What is Data?
+- CLI (using [**_Click_**](https://palletsprojects.com/p/click/)),
+- GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
 
-> ...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)
+[//]: # (- TUI (using [**_Textual_**](https://textual.textualize.io/)) **⚠️Not available yet⚠️**)
 
-### Defining a Graph
+## Install
 
-One can define Graphs in two general ways:
+Graphinate is available on PyPI:
 
-#### Edge first
+```shell
+pip install graphinate
+```
 
-Generate a Graph by supplying a list of edges. The simplest definition of an edge will be a tuple of 2 values. Each
-value represent a node (or vertex) in the graph. Additional attributes may be also added to the edge definition to
-signify additional meaning.
+To install with server support
 
-In this case one defines the **edges explicitly** and the **nodes implicitly**.
+```shell
+pip install graphinate[server]
+```
 
-Such graph is focused more on the _relationships_ or the _structure_ of the Graph than on the nodes themselves.
+Graphinate officially supports Python 3.9+.
 
-#### Node first
+## Quick Start
 
-Alternatively, one can first add nodes (vertices) to a graph without defining edges. Additional attributes may be added
-to the node definition to signify additional meaning. Later on edge definitions are added to generate the relationships
-between the nodes.
+### `GraphModel`
 
-In this case **both nodes and the edges** are defines **explicitly**.
+Graphinate defines the `GraphModel` Class which can be used to declaratively register _Edge_ and/or _Node_ data
+supplier functions by using decorators.
 
-Such a graph has focus first on the nodes and later on the relationship between them.
+### `materialize`
 
-## Gallery
+Graphinate supplies a `materialize` function to output the `GraphModel`.
 
-![d3_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)
-![AST 3D Force animation](https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b)
+### Example
 
-## Examples
+```python
+import graphinate
 
-- [ ] Code
-  - [ ] Call Graph
-  - [x] Python AST
-- [x] GitHub
-  - [x] Repository
-  - [x] Followers
-- [ ] Ethernet
-  - [ ] Traceroute
-- [ ] Math
-  - [x] Graph Atlas
-  - [ ] Hailstone
-- [ ] Text
-  - [ ] NLP
-- [ ] Web
-  - [ ] Web Graph
+N: int = 8
 
-## Guide
+# Define GraphModel
+graph_model = graphinate.GraphModel(name="Octagonal Graph")
 
-### By Convention
 
-https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/followers.py#L1
+# Register edges supplier function
+@graph_model.edge()
+def edge():
+    for i in range(N):
+        yield {'source': i, 'target': i + 1}
+    yield {'source': N, 'target': 0}
 
-### By Configuration
 
-https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/repositories.py#L1
+# Materialize the GraphModel
+graphinate.materialize(graph_model)
+```
 
 ## CLI
 
@@ -143,6 +116,24 @@ Options:
   --help              Show this message and exit.
 ```
 
+## TUI
+
+UNDER DEVELOPMENT
+
+## Gallery
+
+### Python AST
+
+![d3_graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
+
+### GitHub Repository
+
+![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
+
+### Python AST - 3D Force-Directed Animation
+
+![AST 3D Force animation](https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b)
+
 ## Development
 
 ### Lint
@@ -173,13 +164,19 @@ python -m build
 
 ### Dependencies
 
-<a href="https://vasturiano.github.io/3d-force-graph/"><img height="50" style="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>
+#### Python
+
 <a href="https://palletsprojects.com/p/click/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://click.palletsprojects.com/en/7.x/_images/click-logo.png" alt="Click Logo."></a>
 <a href="https://github.com/Delgan/loguru"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://raw.githubusercontent.com/Delgan/loguru/master/docs/_static/img/logo.png" alt="Loguru Logo."></a>
 <a href="https://matplotlib.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://matplotlib.org/_static/logo_dark.svg" alt="matplotlib Logo."></a>
 <a href="https://networkx.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://networkx.org/_static/networkx_logo.svg" alt="NetworkX Logo."></a>
 <a href="https://strawberry.rocks/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/strawberry-graphql/strawberry/raw/main/.github/logo.png" alt="Strawberry GraphQL Logo."></a>
 
+#### Javascript and HTML
+
+<a href="https://vasturiano.github.io/3d-force-graph/"><img height="50" style="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 height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/graphql-kit/graphql-voyager/raw/main/docs/cover.png" alt="Graphql Voyager Logo."></a>
+
 ### Dev Tools
 
 <a href="https://hatch.pypa.io/"><img height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://hatch.pypa.io/latest/assets/images/logo.svg" alt="Hatch logo."></a>

graphinate-0.0.9/docs/acknowledgements.md

@@ -0,0 +1,26 @@
+# Acknowledgements
+
+## Dependencies
+
+### Python
+
+<a href="https://palletsprojects.com/p/click/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://click.palletsprojects.com/en/7.x/_images/click-logo.png" alt="Click Logo."></a>
+<a href="https://github.com/Delgan/loguru"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://raw.githubusercontent.com/Delgan/loguru/master/docs/_static/img/logo.png" alt="Loguru Logo."></a>
+<a href="https://matplotlib.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://matplotlib.org/_static/logo_dark.svg" alt="matplotlib Logo."></a>
+<a href="https://networkx.org/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://networkx.org/_static/networkx_logo.svg" alt="NetworkX Logo."></a>
+<a href="https://strawberry.rocks/"><img height="50" style="padding: 5px; background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://github.com/strawberry-graphql/strawberry/raw/main/.github/logo.png" alt="Strawberry GraphQL Logo."></a>
+
+### Javascript and HTML
+
+<a href="https://vasturiano.github.io/3d-force-graph/"><img height="50" style="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 height="50" style="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>
+
+## Dev Tools
+
+<a href="https://hatch.pypa.io/"><img height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://hatch.pypa.io/latest/assets/images/logo.svg" alt="Hatch logo."></a>
+<a href="https://pytest.org"><img height="50" style="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 height="50" style="background: linear-gradient(-45deg, #FFFFFF, #CCCCCC);" src="https://astralcms.wpengine.com/wp-content/uploads/2023/03/Ruff-Logo.svg" alt="Ruff logo."></a>
+
+## IDE
+
+<a href="https://www.jetbrains.com/pycharm/"><img height="50" style="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.0.9/docs/examples.md

@@ -0,0 +1,18 @@
+# Examples
+
+- Code
+    - Call Graph
+    - Python AST
+- GitHub
+    - Repository
+    - Followers
+- Ethernet
+    - Traceroute
+- Math
+    - Graph Atlas
+    - Hailstone
+    - Polygonal Graph
+- Text
+    - NLP
+- Web
+    - Web Graph

graphinate-0.0.9/docs/gallery.md

@@ -0,0 +1,13 @@
+# Gallery
+
+## Python AST
+
+![d3_graph_ast](https://github.com/erivlis/graphinate/assets/9897520/9e7e1ed2-3a5c-41fe-8c5f-999da4b741ff)
+
+## GitHub Repository
+
+![repo_graph](https://github.com/erivlis/graphinate/assets/9897520/9c044bbe-1f21-41b8-b879-95b8362ad48d)
+
+## Python AST - 3D Force-Directed Animation
+
+![AST 3D Force animation](https://github.com/erivlis/graphinate/assets/9897520/2e9a53b1-5686-4683-a0e4-fbffa850a27b)

graphinate-0.0.9/docs/index.md

@@ -0,0 +1,13 @@
+# Graphinate. Data to Graphs.
+
+![PyPI](https://img.shields.io/pypi/v/graphinate)
+![PyPI - Status](https://img.shields.io/pypi/status/graphinate)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/graphinate)
+![GitHub](https://img.shields.io/github/license/erivlis/graphinate)
+![PyPI - Downloads](https://img.shields.io/pypi/dd/graphinate)
+![GitHub repo size](https://img.shields.io/github/repo-size/erivlis/graphinate)
+[![Contributors](https://img.shields.io/github/contributors/erivlis/graphinate.svg)](https://github.com/erivlis/graphinate/graphs/contributors)
+![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/erivlis/graphinate)
+
+[![Tests](https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/erivlis/graphinate/actions/workflows/test.yml)
+[![Publish](https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg)](https://github.com/erivlis/graphinate/actions/workflows/publish.yml)

graphinate-0.0.9/docs/install.md

@@ -0,0 +1,15 @@
+## Install
+
+Graphinate is available on PyPI:
+
+```shell
+pip install graphinate
+```
+
+To install with server support
+
+```shell
+pip install graphinate[server]
+```
+
+Graphinate officially supports Python 3.9+.

graphinate-0.0.9/docs/intro.md

@@ -0,0 +1,63 @@
+# Introduction
+
+## What is Graphinate?
+
+Graphinate is a library that aims to simplify the generation of Graph Data Structures from Data Sources.
+
+It utilizes and builds upon the excellent [**_NetworkX_**](https://networkx.org/) library.
+
+In addition, it has several interfaces for ease of use:
+
+  - CLI (using [**_Click_**](https://palletsprojects.com/p/click/)),
+  - TUI (using [**_Textual_**](https://textual.textualize.io/)) **⚠️Not available yet⚠️**
+  - GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
+
+## 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)
+
+## A Graph as Data Structure
+
+A Graph is a very useful data structure. They are the simplest data structure that is more the just simple collection of
+entities. As such they can be used to model all data sources that have structure.
+
+Let's start with a simple use case, The Social Network Graph.
+
+## Defining a Graph
+
+One can define a Graph in two general ways:
+
+### Edge first
+
+Generate a Graph by supplying a list of edges. The simplest definition of an edge will be a tuple of 2 values. Each
+value represent a node (or vertex) in the graph. Additional attributes may be also added to the edge definition to
+signify additional meaning.
+
+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.
+
+### Node first
+
+Alternatively, one can first add nodes (vertices) to a graph without defining edges. Additional attributes may be added
+to the node definition to signify additional meaning. Later on edge definitions are added to generate the relationships
+between the nodes.
+
+In this case **both nodes and the edges** are defines **explicitly**.
+
+Such a graph has focus first on the nodes and later on the relationship between them.
+
+## Graphinate - Hydrate a Graph from a Data Source

graphinate-0.0.9/docs/start.md

@@ -0,0 +1,37 @@
+
+## Quick Start
+
+Graphinate is designed to be used as library first and foremost. In addition, it has several interfaces for ease of
+use: CLI, TUI (using [Textual]) and a GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
+
+### GraphModel
+
+Graphinate defines the _**GraphModel**_ Class which can be used to declaratively register Edge and/or Node data
+supplier functions by using decorators.
+
+### Materialize
+
+Graphinate supplies quick materialize function to output the GraphModel.
+
+### Sample Code
+
+```python
+import graphinate
+
+# Define GraphModel
+model = graphinate.GraphModel(name= "Octagonal Graph")
+
+# Register edges supplier function
+N: int = 8
+
+
+@model.edge()
+def edge():
+    for i in range(N):
+        yield {'source': i, 'target': i + 1}
+    yield {'source': N, 'target': 0}
+
+
+# Materialize the GraphModel
+graphinate.materialize(model)
+```

graphinate-0.0.9/docs/usage.md

@@ -0,0 +1,19 @@
+# Usage
+
+## Model
+
+## Build
+
+## Materialize
+
+
+
+
+
+### By Convention
+
+https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/followers.py
+
+### By Configuration
+
+https://github.com/erivlis/graphinate/blob/f5b363a360907aecf52cf11249b78666eb470d20/examples/github/repositories.py

{graphinate-0.0.8 → graphinate-0.0.9}/examples/code/python_ast.py

@@ -29,7 +29,7 @@ def _ast_edge(parsed_ast: AST):
 
 
 def ast_graph_model():
-    graph_model = graphinate.GraphModel(name='AST')
+    graph_model = graphinate.GraphModel(name='AST Graph')
 
     root_ast_node = ast.parse(inspect.getsource(graphinate.builders.D3Builder))
 
@@ -58,4 +58,4 @@ def ast_graph_model():
 
 if __name__ == '__main__':
     ast_model = ast_graph_model()
-    graphinate.materialize("AST Graph", ast_model)
+    graphinate.materialize(ast_model)

{graphinate-0.0.8 → graphinate-0.0.9}/examples/github/followers.py

@@ -7,7 +7,7 @@ DEPTH = 0
 
 
 def followers_graph_model(max_depth: int = DEPTH):
-    graph_model = graphinate.GraphModel(name='github-followers')
+    graph_model = graphinate.GraphModel(name='Github Followers Graph')
 
     def _followers(user_id: Optional[str] = None, depth: int = 0, **kwargs):
         user = github_user(user_id)
@@ -34,8 +34,7 @@ if __name__ == '__main__':
     }
 
     graphinate.materialize(
-        title="Github Followers Graph",
-        graph_model=followers_model,
+        model=followers_model,
         graph_type=graphinate.GraphType.DiGraph,
         default_node_attributes={'type': 'user'},
         **params

{graphinate-0.0.8 → graphinate-0.0.9}/examples/github/repositories.py

@@ -7,11 +7,11 @@ import pathlib
 from typing import Optional
 
 import graphinate
-from _client import github_user, github_repositories, github_commits, github_files
+from _client import github_commits, github_files, github_repositories, github_user
 
 
 def repo_graph_model():
-    graph_model = graphinate.GraphModel(name='github-repository')
+    graph_model = graphinate.GraphModel(name='GitHub Repository Graph')
 
     @graph_model.edge
     def github(user_id: Optional[str] = None,
@@ -60,8 +60,7 @@ def repo_graph_model():
                    repository_id: Optional[str] = None,
                    **kwargs):
         repos = github_repositories(user_id, repository_id)
-        for repo in repos:
-            yield repo
+        yield from repos
 
     @commit_node
     def commit(user_id: Optional[str] = None,
@@ -110,4 +109,4 @@ if __name__ == '__main__':
         # 'user_id' "strawberry-graphql"
     }
 
-    graphinate.materialize("GitHub Repository Graph", repo_model, **params)
+    graphinate.materialize(repo_model, **params)

{graphinate-0.0.8 → graphinate-0.0.9}/examples/math/graph_atlas.py

@@ -782,4 +782,4 @@ if __name__ == '__main__':
     choices = graphinate.tools.gui.modal_listbox_chooser('Choose Graph', atlas())
 
     for model in models(choices):
-        graphinate.materialize(model.name, model)
+        graphinate.materialize(model)

{graphinate-0.0.8 → graphinate-0.0.9}/examples/math/hailstone.py

@@ -1,5 +1,5 @@
 import graphinate
-from graphinate.materialize.matplotlib import show
+from graphinate.materializers.matplotlib import plot
 
 graph_model = graphinate.model(name='Hailstone')
 
@@ -22,4 +22,4 @@ if __name__ == '__main__':
         'h_id': 7
     }
     graph = networkx_graph.build(**params)
-    show(graph)
+    plot(graph)

graphinate-0.0.9/examples/math/polygonal_graph.py

@@ -0,0 +1,36 @@
+import graphinate
+import networkx as nx
+
+N: int = 8
+
+# Define GraphModel
+graph_model = graphinate.GraphModel(name="Octagonal Graph")
+
+
+# Register edges supplier function
+@graph_model.edge()
+def edge():
+    for i in range(N):
+        yield {'source': i, 'target': i + 1}
+    yield {'source': N, 'target': 0}
+
+
+# Materialize the GraphModel
+graphinate.materialize(graph_model)
+
+# Or
+
+# 1. Define Graph Builder
+builder = graphinate.builders.NetworkxBuilder(model=graph_model)
+
+# Then
+# 2. Build the Graph object
+graph: nx.Graph = builder.build()
+
+# Then
+# 3. Option A - Output to console
+print(graph)
+
+# Or
+# 3. Option B - Output as a plot
+graphinate.materializers.plot(graph)

{graphinate-0.0.8 → graphinate-0.0.9}/examples/text/nlp_graph.py

@@ -11,5 +11,4 @@ for chunk in doc.noun_chunks:
           chunk.root.head.text)
 
 for token in doc:
-    print(token.text, token.dep_, token.head.text, token.head.pos_,
-            [child for child in token.children])
+    print(token.text, token.dep_, token.head.text, token.head.pos_, list(token.children))

{graphinate-0.0.8 → graphinate-0.0.9}/examples/web/web_graph.py

@@ -4,7 +4,7 @@ import graphinate.builders
 import networkx as nx
 import requests
 from bs4 import BeautifulSoup
-from graphinate.materialize.matplotlib import show
+from graphinate.materializers import plot
 
 DEPTH = 0
 
@@ -49,4 +49,4 @@ if __name__ == '__main__':
 
     nx_graph: nx.Graph = networkx_graph.build(url=base_url)
 
-    show(nx_graph)
+    plot(nx_graph)

{graphinate-0.0.8 → graphinate-0.0.9}/mkdocs.yml

@@ -57,9 +57,15 @@ markdown_extensions:
   - pymdownx.superfences
 
 nav:
-  - Introduction: index.md
+  - Home: index.md
   - Install: install.md
+  - Introduction: intro.md
+  - Quick Start: start.md
+  - Gallery: gallery.md
   - Usage: usage.md
+  - Examples: examples.md
+#  - Acknowledgements: acknowledgements.md
+
 
 extra:
   social:

{graphinate-0.0.8 → graphinate-0.0.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Graphinate"
-version = "0.0.8"
+version = "0.0.9"
 authors = [
     { name = "Eran Rivlis", email = "eran@rivlis.info" },
 ]
@@ -55,7 +55,6 @@ test = [
     # "pytest-xdist",
 ]
 plot = [
-    "matplotlib",
     "scipy"
 ]
 server = [
@@ -104,6 +103,7 @@ exclude = [
     ".git",
     ".git-rewrite",
     ".hg",
+    ".idea",
     ".mypy_cache",
     ".nox",
     ".pants.d",
@@ -117,7 +117,6 @@ exclude = [
     "buck-out",
     "build",
     "dist",
-    "node_modules",
     "venv",
 ]
 

{graphinate-0.0.8 → graphinate-0.0.9}/src/graphinate/__init__.py

@@ -1,6 +1,6 @@
 from . import builders
 from .builders import GraphType
-from .materialize import materialize
+from .materializers import materialize
 from .modeling import UNIVERSE_NODE, GraphModel
 
 

{graphinate-0.0.8 → graphinate-0.0.9}/src/graphinate/cli.py

@@ -4,7 +4,7 @@ import json
 import click
 
 from . import builders
-from .materialize import materialize
+from .materializers import materialize
 from .modeling import GraphModel
 from .server import DEFAULT_PORT, run_graphql
 from .tools.importer import import_from_string
@@ -20,8 +20,7 @@ def cli(*args, **kwargs):
 def save(model, *args, **kwargs):
     graph_model: GraphModel = import_from_string(model) if isinstance(model, str) else model
     with open(f"{graph_model.name}.json", mode='w') as fp:
-        materialize(title=graph_model.name,
-                    graph_model=graph_model,
+        materialize(model=graph_model,
                     builder=builders.D3Builder,
                     actualizer=functools.partial(json.dump, fp=fp, default=str))
 
@@ -31,7 +30,6 @@ def save(model, *args, **kwargs):
 @click.option('-p', '--port', type=int, default=DEFAULT_PORT)
 def server(model, port, *args, **kwargs):
     graph_model: GraphModel = import_from_string(model) if isinstance(model, str) else model
-    materialize(title=graph_model.name,
-                graph_model=graph_model,
+    materialize(model=graph_model,
                 builder=builders.GraphQLBuilder,
                 actualizer=functools.partial(run_graphql, port=port))

{graphinate-0.0.8/src/graphinate/materialize → graphinate-0.0.9/src/graphinate/materializers}/__init__.py

@@ -5,23 +5,26 @@ from typing import Callable, Optional
 
 from .. import builders, modeling, server
 from ..tools.gui import modal_radiobutton_chooser
-from .matplotlib import show
+from .matplotlib import plot
+
+graphql = server.run_graphql
 
 
 class Materializers(Enum):
-    NetworkX = (builders.NetworkxBuilder, show)
+    NetworkX = (builders.NetworkxBuilder, plot)
     D3Graph = (builders.D3Builder, pprint)
-    GraphQL = (builders.GraphQLBuilder, server.run_graphql)
-    D3GraphQL = (builders.D3GraphQLBuilder, server.run_graphql)
+    GraphQL = (builders.GraphQLBuilder, graphql)
+    D3GraphQL = (builders.D3GraphQLBuilder, graphql)
 
 
-def materialize(title: str,
-                graph_model: modeling.GraphModel,
+def materialize(model: modeling.GraphModel,
+                title: Optional[str] = None,
                 graph_type: builders.GraphType = builders.GraphType.Graph,
                 default_node_attributes: Optional[Mapping] = None,
                 builder: Optional[type[builders.Builder]] = None,
                 actualizer: Optional[Callable] = None,
                 **kwargs):
+    title = title or model.name
     if builder is None and actualizer is None:
         result = modal_radiobutton_chooser(title,
                                            options={m.name: m.value for m in Materializers},
@@ -30,8 +33,11 @@ def materialize(title: str,
             builder, actualizer = result[1]
 
     materialized_graph = builders.build(builder,
-                                        graph_model,
+                                        model,
                                         graph_type,
                                         default_node_attributes=default_node_attributes,
                                         **kwargs)
     actualizer(materialized_graph)
+
+
+__all__ = ('materialize', 'plot', 'graphql')

{graphinate-0.0.8/src/graphinate/materialize → graphinate-0.0.9/src/graphinate/materializers}/matplotlib.py

@@ -1,15 +1,15 @@
 import networkx as nx
-from matplotlib import pyplot as plt
+from matplotlib import pyplot
 
 from ..color import node_color_mapping
 
 
-def nodes_labels(graph: nx.Graph):
+def _nodes_labels(graph: nx.Graph):
     # return {node: data.get('label', node) or node for node, data in graph.nodes.data()}
     return nx.get_node_attributes(graph, 'label')
 
 
-def edges_labels(graph: nx.Graph):
+def _edges_labels(graph: nx.Graph):
     return nx.get_edge_attributes(graph, 'label')
 
 
@@ -22,7 +22,7 @@ def draw(graph: nx.Graph, with_labels=True):
         draw_params.update(
             {
                 'with_labels': True,
-                'labels': nodes_labels(graph),
+                'labels': _nodes_labels(graph),
                 'font_size': 6,
                 'font_color': 'blue',
                 # 'horizontalalignment':'left',
@@ -39,9 +39,9 @@ def draw(graph: nx.Graph, with_labels=True):
 
     node_color = list(node_color_mapping(graph).values())
     nx.draw(graph, pos, node_color=node_color, **draw_params)
-    nx.draw_networkx_edge_labels(graph, pos, edge_labels=edges_labels(graph), font_color='red', font_size=6)
+    nx.draw_networkx_edge_labels(graph, pos, edge_labels=_edges_labels(graph), font_color='red', font_size=6)
 
 
-def show(graph: nx.Graph):
+def plot(graph: nx.Graph):
     draw(graph)
-    plt.show()
+    pyplot.show()

{graphinate-0.0.8 → graphinate-0.0.9}/src/graphinate/modeling.py

@@ -129,7 +129,7 @@ class GraphModel:
              key: Optional[Extractor] = None,
              value: Optional[Extractor] = None,
              label: Optional[Extractor] = None) -> Callable[[Items], None]:
-        """Decorator to Register a Generator of node payloads as a source to materialize Graph Nodes. It creates a
+        """Decorator to Register a Generator of node payloads as a source to create Graph Nodes. It creates a
         NodeModel object.
         :param _type: Optional source for the Node Type. Defaults to use Generator function name as the Node Type.
         :param parent_type: Optional parent Node Type. Defaults to UNIVERSE_NODE
@@ -170,7 +170,7 @@ class GraphModel:
              value: Optional[Extractor] = None,
              weight: Union[float, Callable[[Any], float]] = 1.0,
              ) -> Callable[[Items], None]:
-        """Decorator to Register a Generator of edge payloads as a source to materialize Graph Edges. It creates an Edge
+        """Decorator to Register a Generator of edge payloads as a source to create Graph Edges. It creates an Edge
         Generator function.
         :param _type:
         :param source:

graphinate-0.0.8/docs/index.md

@@ -1,7 +0,0 @@
-# Graphinate. Data to Graphs.
-![PyPI](https://img.shields.io/pypi/v/graphinate) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/graphinate) [![Contributors](https://img.shields.io/github/contributors/erivlis/graphinate.svg)](https://github.com/erivlis/graphinate/graphs/contributors) [![Tests](https://github.com/erivlis/graphinate/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/erivlis/graphinate/actions/workflows/test.yml) [![Publish](https://github.com/erivlis/graphinate/actions/workflows/publish.yml/badge.svg)](https://github.com/erivlis/graphinate/actions/workflows/publish.yml)
-
-
-## Edge First
-
-## Node First

graphinate-0.0.8/docs/install.md

@@ -1,9 +0,0 @@
-# Install
-
-## PyPI
-
-Graphinate is available on PyPI:
-
-```shell
-python -m pip install graphinate 
-```

graphinate-0.0.8/docs/usage.md

@@ -1,10 +0,0 @@
-# Usage
-
-## Model
-
-## Build
-
-## Materialize
-
-
-