Graphinate 0.0.7__tar.gz → 0.0.9__tar.gz

graphinate-0.0.9/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.1
+Name: Graphinate
+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
+Project-URL: Bug Tracker, https://github.com/erivlis/graphinate/issues
+Project-URL: Source, https://github.com/erivlis/graphinate
+Author-email: Eran Rivlis <eran@rivlis.info>
+License-File: LICENSE
+Keywords: declarative,graph
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: click>=8
+Requires-Dist: inflect>=7
+Requires-Dist: loguru>=0.7
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: networkx>=3
+Requires-Dist: strawberry-graphql[asgi,opentelemetry]
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: plot
+Requires-Dist: scipy; extra == 'plot'
+Provides-Extra: server
+Requires-Dist: starlette-prometheus; extra == 'server'
+Requires-Dist: uvicorn[standard]; extra == 'server'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest>=7.3.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Graphinate. Data to Graphs.
+
+> [!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)
+![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)
+
+## 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/)),
+- GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
+
+[//]: # (- TUI &#40;using [**_Textual_**]&#40;https://textual.textualize.io/&#41;&#41; **⚠️Not available yet⚠️**)
+
+## 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+.
+
+## Quick Start
+
+### `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 a `materialize` function to output the `GraphModel`.
+
+### Example
+
+```python
+import graphinate
+
+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)
+```
+
+## CLI
+
+### Commands
+
+```
+Usage: python -m graphinate [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  save
+  server
+```
+
+#### Save
+
+```
+Usage: python -m graphinate save [OPTIONS] MODEL
+
+Options:
+  --help  Show this message and exit.
+```
+
+#### Server
+
+```
+Usage: python -m graphinate server [OPTIONS] MODEL
+
+Options:
+  -p, --port INTEGER
+  --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
+
+```shell
+ruff check src
+```
+
+### Docs
+
+```shell
+python -m mkdocs build
+```
+
+### Build
+
+```shell
+python -m build
+```
+
+### Test
+
+```shell
+ python -m pytest ./tests --cov=./src --cov-branch --cov-report=xml --junitxml=test_results.xml
+```
+
+## 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="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>
+<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/README.md

@@ -0,0 +1,188 @@
+# Graphinate. Data to Graphs.
+
+> [!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)
+![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)
+
+## 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/)),
+- GraphQL API (using [**_Strawberry GraphQL_**](https://strawberry.rocks/)).
+
+[//]: # (- TUI (using [**_Textual_**](https://textual.textualize.io/)) **⚠️Not available yet⚠️**)
+
+## 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+.
+
+## Quick Start
+
+### `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 a `materialize` function to output the `GraphModel`.
+
+### Example
+
+```python
+import graphinate
+
+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)
+```
+
+## CLI
+
+### Commands
+
+```
+Usage: python -m graphinate [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  save
+  server
+```
+
+#### Save
+
+```
+Usage: python -m graphinate save [OPTIONS] MODEL
+
+Options:
+  --help  Show this message and exit.
+```
+
+#### Server
+
+```
+Usage: python -m graphinate server [OPTIONS] MODEL
+
+Options:
+  -p, --port INTEGER
+  --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
+
+```shell
+ruff check src
+```
+
+### Docs
+
+```shell
+python -m mkdocs build
+```
+
+### Build
+
+```shell
+python -m build
+```
+
+### Test
+
+```shell
+ python -m pytest ./tests --cov=./src --cov-branch --cov-report=xml --junitxml=test_results.xml
+```
+
+## 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="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>
+<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/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.7 → graphinate-0.0.9}/examples/code/python_ast.py

@@ -2,7 +2,7 @@ import ast
 import inspect
 import operator
 from _ast import AST
-from typing import Iterable
+from collections.abc import Iterable
 
 import graphinate
 import graphinate.builders
@@ -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.9/examples/code/requirements.txt

@@ -0,0 +1 @@
+PyGithub