Graphinate 0.2.21__tar.gz → 0.3.1__tar.gz

{graphinate-0.2.21 → graphinate-0.3.1}/.github/workflows/test-beta.yml

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

{graphinate-0.2.21 → graphinate-0.3.1}/.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.10", "3.11", "3.12", "3.13"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
@@ -43,3 +43,12 @@ jobs:
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Run codacy-coverage-reporter
+        uses: codacy/codacy-coverage-reporter-action@v1.3.0
+        with:
+          #project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          # or
+          api-token: ${{ secrets.CODACY_API_TOKEN }}
+          coverage-reports: coverage.xml
+          # or a comma-separated list for multiple reports
+          # coverage-reports: <PATH_TO_REPORT>, <PATH_TO_REPORT>

{graphinate-0.2.21 → graphinate-0.3.1}/.gitignore

@@ -781,3 +781,4 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+/.idea/**

{graphinate-0.2.21 → graphinate-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Graphinate
-Version: 0.2.21
+Version: 0.3.1
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
@@ -9,7 +9,7 @@ Project-URL: Source, https://github.com/erivlis/graphinate
 Author-email: Eran Rivlis <eran@rivlis.info>
 License-File: LICENSE
 Keywords: declarative,graph
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Science/Research
@@ -18,21 +18,21 @@ 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 :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: click>=8.1.7
-Requires-Dist: inflect>=7.2.1
+Requires-Dist: inflect>=7.3.0
 Requires-Dist: loguru>=0.7.2
-Requires-Dist: matplotlib>=3.8.4
+Requires-Dist: matplotlib>=3.9.0
 Requires-Dist: networkx>=3.3
-Requires-Dist: strawberry-graphql[asgi,opentelemetry]>=0.227.3
+Requires-Dist: strawberry-graphql[asgi,opentelemetry]>=0.235.1
 Provides-Extra: dev
 Requires-Dist: pipdeptree; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
@@ -45,17 +45,17 @@ Requires-Dist: mkdocs-material; extra == 'docs'
 Requires-Dist: mkdocs-section-index; extra == 'docs'
 Requires-Dist: mkdocstrings-python; extra == 'docs'
 Provides-Extra: plot
-Requires-Dist: scipy>=1.12.0; extra == 'plot'
+Requires-Dist: scipy>=1.14.0; extra == 'plot'
 Provides-Extra: server
 Requires-Dist: starlette-prometheus; extra == 'server'
-Requires-Dist: uvicorn[standard]>=0.29.0; extra == 'server'
+Requires-Dist: uvicorn[standard]>=0.30.1; extra == 'server'
 Provides-Extra: test
 Requires-Dist: faker>=23.2.1; extra == 'test'
-Requires-Dist: pytest-asyncio>=0.23.5; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23.7; extra == 'test'
 Requires-Dist: pytest-cov>=5.0.0; extra == 'test'
 Requires-Dist: pytest-randomly>=3.15.0; extra == 'test'
-Requires-Dist: pytest-xdist>=3.5.0; extra == 'test'
-Requires-Dist: pytest>=8.1.1; extra == 'test'
+Requires-Dist: pytest-xdist>=3.6.1; extra == 'test'
+Requires-Dist: pytest>=8.2.2; extra == 'test'
 Description-Content-Type: text/markdown
 
 # [Graphinate. Data to Graphs.](https://erivlis.github.io/graphinate/)
@@ -81,10 +81,10 @@ Description-Content-Type: text/markdown
     <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://squidfunk.github.io/mkdocs-material/"><img src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?&logo=MaterialForMkDocs&logoColor=white&labelColor=grey"></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/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/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://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://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>
     </td>
   </tr>
   <tr>
@@ -110,6 +110,7 @@ Description-Content-Type: text/markdown
       <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://snyk.io/test/github/erivlis/graphinate"><img alt="Snyk" src="https://snyk.io/test/github/erivlis/Graphinate/badge.svg"></a -->
     </td>
@@ -133,9 +134,9 @@ In addition, there are several modes of output to enable examination of the Grap
 
 ### Links
 
-- Website (including documentation): https://erivlis.github.io/graphinate
-- Source: https://github.com/erivlis/graphinate
-- Package: https://pypi.org/project/graphinate
+- Website (including documentation): <https://erivlis.github.io/graphinate>
+- Source: <https://github.com/erivlis/graphinate>
+- Package: <https://pypi.org/project/graphinate>
 
 ## Quick Start
 
@@ -153,7 +154,7 @@ To install with server support
 pip install graphinate[server]
 ```
 
-**Graphinate** officially supports Python >= 3.9.
+**Graphinate** officially supports Python >= 3.10.
 
 ### Example
 
@@ -178,11 +179,17 @@ def edge():
 graphinate.materialize(graph_model)
 ```
 
+
+
+#### `graphinate.model` function
+
 > [!NOTE]
-> ### `graphinate.model` function
 > 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.
-> ### `graphinate.materialize` function
+
+#### `graphinate.materialize` function
+
+> [!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.
 
@@ -190,7 +197,7 @@ graphinate.materialize(graph_model)
 
 ### Commands
 
-```
+```text
 Usage: python -m graphinate [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -203,7 +210,7 @@ Commands:
 
 #### Save
 
-```
+```text
 Usage: python -m graphinate save [OPTIONS]
 
 Options:
@@ -216,7 +223,7 @@ Options:
 
 #### Server
 
-```
+```text
 Usage: python -m graphinate server [OPTIONS]
 
 Options:
@@ -312,7 +319,7 @@ python -m mkdocs build
 
 <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>
 
-------
+---------------------
 
 <img alt="Star Chart" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
 

{graphinate-0.2.21 → graphinate-0.3.1}/README.md

@@ -21,10 +21,10 @@
     <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://squidfunk.github.io/mkdocs-material/"><img src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?&logo=MaterialForMkDocs&logoColor=white&labelColor=grey"></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/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/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://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://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>
     </td>
   </tr>
   <tr>
@@ -50,6 +50,7 @@
       <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://snyk.io/test/github/erivlis/graphinate"><img alt="Snyk" src="https://snyk.io/test/github/erivlis/Graphinate/badge.svg"></a -->
     </td>
@@ -73,9 +74,9 @@ In addition, there are several modes of output to enable examination of the Grap
 
 ### Links
 
-- Website (including documentation): https://erivlis.github.io/graphinate
-- Source: https://github.com/erivlis/graphinate
-- Package: https://pypi.org/project/graphinate
+- Website (including documentation): <https://erivlis.github.io/graphinate>
+- Source: <https://github.com/erivlis/graphinate>
+- Package: <https://pypi.org/project/graphinate>
 
 ## Quick Start
 
@@ -93,7 +94,7 @@ To install with server support
 pip install graphinate[server]
 ```
 
-**Graphinate** officially supports Python >= 3.9.
+**Graphinate** officially supports Python >= 3.10.
 
 ### Example
 
@@ -118,11 +119,17 @@ def edge():
 graphinate.materialize(graph_model)
 ```
 
+
+
+#### `graphinate.model` function
+
 > [!NOTE]
-> ### `graphinate.model` function
 > 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.
-> ### `graphinate.materialize` function
+
+#### `graphinate.materialize` function
+
+> [!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.
 
@@ -130,7 +137,7 @@ graphinate.materialize(graph_model)
 
 ### Commands
 
-```
+```text
 Usage: python -m graphinate [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -143,7 +150,7 @@ Commands:
 
 #### Save
 
-```
+```text
 Usage: python -m graphinate save [OPTIONS]
 
 Options:
@@ -156,7 +163,7 @@ Options:
 
 #### Server
 
-```
+```text
 Usage: python -m graphinate server [OPTIONS]
 
 Options:
@@ -252,7 +259,7 @@ python -m mkdocs build
 
 <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>
 
-------
+---------------------
 
 <img alt="Star Chart" src="https://forthebadge.com/images/badges/works-on-my-machine.svg">
 

{graphinate-0.2.21 → graphinate-0.3.1}/STATS.md

@@ -7,6 +7,12 @@
 
 ## Repos
 
-### Graphinate Stars
+### Graphinate
 
 <img alt="Graphinate Star Chart" src="https://starchart.cc/erivlis/graphinate.svg">
+
+https://starchart.cc/erivlis/graphinate.svg
+
+### MappingTools
+
+<img alt="MappingTools Star Chart" src="https://starchart.cc/erivlis/mappingtools.svg">

{graphinate-0.2.21 → graphinate-0.3.1}/docs/acknowledge.md

@@ -25,4 +25,4 @@
 
 ## 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; 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.2.21 → graphinate-0.3.1}/docs/index.md

@@ -49,6 +49,7 @@
       <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>
     </td>
   </tr>

{graphinate-0.2.21 → graphinate-0.3.1}/docs/start.md

@@ -17,7 +17,7 @@ To install with server support
 pip install graphinate[server]
 ```
 
-**Graphinate** officially supports Python 3.9+.
+**Graphinate** officially supports Python >= 3.10.
 
 ## Demo
 

{graphinate-0.2.21 → graphinate-0.3.1}/examples/code/python_ast.py

@@ -1,3 +1,10 @@
+"""
+Define functions to create an abstract syntax tree (AST) graph model using the 'graphinate' library.
+The 'ast_graph_model' function parses the AST of a specified class and creates nodes and edges for the graph model.
+The nodes represent AST nodes with their type and label, while the edges represent relationships between AST nodes.
+"""
+
+
 import ast
 import hashlib
 import inspect
@@ -35,6 +42,13 @@ def _ast_edge(parsed_ast: AST):
 
 
 def ast_graph_model():
+    """
+    Create an abstract syntax tree (AST) graph model.
+
+    Returns:
+        GraphModel: A graph model representing the AST nodes and their relationships.
+    """
+
     graph_model = graphinate.model(name='AST Graph')
 
     root_ast_node = ast.parse(inspect.getsource(graphinate.builders.D3Builder))

{graphinate-0.2.21 → graphinate-0.3.1}/examples/code/python_dependencies.py

@@ -6,6 +6,13 @@ from pipdeptree._non_host import handle_non_host_target
 
 
 def dependency_graph_model():
+    """
+    Generate a dependency graph model.
+
+    Returns:
+        GraphModel: A graph model representing the dependency graph.
+    """
+
     options = get_options(args=None)
     handle_non_host_target(options)
 

graphinate-0.3.1/examples/github/_client.py

@@ -0,0 +1,132 @@
+import functools
+import os
+from collections.abc import Iterable
+from typing import Optional, Union
+
+# see requirements.txt
+from github import Auth, Github
+from github.AuthenticatedUser import AuthenticatedUser
+from github.Commit import Commit
+from github.File import File
+from github.NamedUser import NamedUser
+from github.Repository import Repository
+
+# define a 'GITHUB_TOKEN' Env Var.
+token = os.getenv('GITHUB_TOKEN')
+
+# using an access token
+auth = Auth.Token(token)
+
+# Public Web GitHub
+client = Github(auth=auth)
+
+
+# or GitHub Enterprise with custom hostname
+# g = Github(auth=auth, base_url='https://{hostname}/api/v3')
+
+
+@functools.lru_cache
+def github_user(user_id: Optional[str] = None) -> Union[NamedUser, AuthenticatedUser]:
+    """
+    Get the GitHub user object for the specified user ID or the authenticated user.
+
+    Parameters:
+        user_id (Optional[str]): The ID of the user to retrieve.
+                                 If not provided, retrieve the authenticated user.
+
+    Returns:
+        Union[NamedUser, AuthenticatedUser]: The GitHub user object corresponding to the user ID provided,
+                                             or the authenticated user if no user ID is specified.
+    Note:
+        This function requires authentication with a valid GitHub token.
+    """
+    user = client.get_user(user_id) if user_id else client.get_user()
+    return user
+
+
+@functools.lru_cache
+def github_repositories(
+        user_id: Optional[str] = None,
+        repo_id: Optional[str] = None) -> Iterable[Repository]:
+    """
+    Get the GitHub repositories for the specified user ID or the authenticated user.
+
+    Parameters:
+        user_id (Optional[str]): The ID of the user whose repositories to retrieve.
+                                 If not provided, retrieve repositories of the authenticated user.
+        repo_id (Optional[str]): The ID of the repository to retrieve.
+                                 If provided, only that repository will be returned.
+
+    Returns:
+        Iterable[Repository]:
+        A list of GitHub repository objects corresponding to the user ID and/or repository ID provided.
+
+    Note:
+        This function requires authentication with a valid GitHub token.
+    """
+
+    user = github_user(user_id)
+    if repo_id and (repo := user.get_repo(name=repo_id)):
+        return [repo]
+    else:
+        return user.get_repos()
+
+
+def github_commits(
+        repo: Repository,
+        commit_id: Optional[str] = None) -> Iterable[Commit]:
+    """
+    Retrieve commits from a GitHub repository.
+
+    Parameters:
+        repo (Repository): The GitHub repository object from which to retrieve commits.
+        commit_id (str, optional): The ID of the commit to retrieve.
+                                   If provided, only that commit will be returned.
+                                   Defaults to None.
+
+    Returns:
+        Iterable[Commit]: An Iterable of Commit objects representing the commits in the repository.
+
+    Example:
+        To retrieve all commits from a repository:
+        ```
+        for commit in github_commits(repo):
+            print(commit)
+        ```
+
+        To retrieve a specific commit by ID:
+        ```
+        for commit in github_commits(repo, commit_id='abcdef123456'):
+            print(commit)
+        ```
+
+    Note:
+        This function requires authentication with a valid GitHub token.
+    """
+    if commit_id and (commit := repo.get_commit(sha=commit_id)):
+        yield commit
+    else:
+        yield from repo.get_commits()
+
+
+def github_files(
+        commit: Commit,
+        file_id: Optional[str] = None) -> Iterable[File]:
+    """
+    Retrieves Files from a GitHub Commit
+
+    Parameters:
+        commit (Commit): A Commit object from the GitHub API.
+        file_id (Optional[str]): An optional parameter specifying the filename to filter the files. Default is None.
+
+    Returns:
+        Iterable[File]: An Iterable of File objects based on the filtering criteria.
+
+    Note:
+        This function requires authentication with a valid GitHub token.
+    """
+    files: list[File] = commit.files
+    if file_id:
+        yield from [file for file in files if file.filename == file_id]
+    else:
+        yield from files

{graphinate-0.2.21 → graphinate-0.3.1}/examples/github/followers.py

@@ -1,3 +1,9 @@
+"""
+Defines a function `followers_graph_model` that creates a graph model representing GitHub followers.
+It recursively fetches followers of a given user up to a specified maximum depth.
+The function yields edges between users in the graph.
+"""
+
 from typing import Optional
 
 import graphinate
@@ -7,6 +13,16 @@ DEPTH = 0
 
 
 def followers_graph_model(max_depth: int = DEPTH):
+    """
+    Create a graph model representing GitHub followers.
+
+    Args:
+        max_depth (int): The maximum depth to fetch followers recursively (default is 0).
+
+    Returns:
+        GraphModel: A graph model representing GitHub followers.
+    """
+
     graph_model = graphinate.model(name='Github Followers Graph')
 
     def _followers(user_id: Optional[str] = None, depth: int = 0, **kwargs):

{graphinate-0.2.21 → graphinate-0.3.1}/examples/github/repositories.py

@@ -8,6 +8,13 @@ from _client import github_commits, github_files, github_repositories, github_us
 
 
 def repo_graph_model():  # noqa: C901
+    """
+    Create a graph model for GitHub repositories.
+
+    Returns:
+        GraphModel: A graph model representing GitHub repositories with nodes and edges.
+    """
+
     graph_model = graphinate.model(name='GitHub Repository Graph')
 
     @graph_model.edge

{graphinate-0.2.21 → graphinate-0.3.1}/examples/math/graph_atlas.py

@@ -35,6 +35,21 @@ def spiral_torus_edges(n, k):
 
 
 def atlas():
+    """
+    Generate a dictionary of various graph structures and models based on the provided atlas.
+    The function creates different types of graphs and models using NetworkX library.
+    The generated graphs include Tetrahedron, Cube, Octahedron, Dodecahedron, Icosahedron, Tesseract, Truncated Cube,
+    Truncated Tetrahedron, Ladder, Ring, Möbius, Cylinder, Spiral, Spiral Torus, and Circulant[10,[2]].
+    Additionally, the function includes adjacency mappings for specific named graphs like
+    Buckyball - Truncated Icosahedral Graph, D30 - Rhombic Triacontahedral Graph, Small Rhombicosidodecahedral Graph,
+    Small Rhombicuboctahedral Graph, Great Rhombicosidodecahedral Graph, Disdyakis Dodecahedral Graph,
+    Deltoidal Icositetrahedral Graph, Icosidodecahedral Graph, Deltoidal Hexecontahedral Graph, Kocohl74,
+    Utility Graph, Errara Graph, and Dragon Curve Blob 6.
+    The adjacency mappings define the connections between nodes in each named graph.
+    The function returns a dictionary
+    containing the named graphs as keys and their corresponding NetworkX graph objects as values.
+    """
+
     ladder_size = 16
     ladder = nx.ladder_graph(ladder_size)
 
@@ -775,6 +790,21 @@ def atlas():
 
 
 def models(iterable):
+    """
+    Generate a graph model based on the provided iterable of graphs.
+    The function creates a graph model named 'Graph Atlas' using the 'graphinate' library.
+    It then combines all the graphs from the input iterable into a single disjoint union graph using NetworkX library.
+    The function defines edges for the combined graph by iterating over all edges in the disjoint union graph and
+    yielding dictionaries with 'source' and 'target' keys representing the edge connections.
+    Finally, the function yields the created graph model containing the combined graph with defined edges.
+
+    Args:
+        iterable: An iterable containing graphs to be combined into a single graph model.
+
+    Yields:
+        GraphModel: A graph model containing the combined graph with defined edges.
+    """
+
     graph_model = graphinate.model('Graph Atlas')
 
     graph_atlas = nx.disjoint_union_all(g for _, g in iterable)