add stubs and python linter (#2207)

Add stubs generation and black linting to pr checks and bot commits

Author: jbaross-pometry

.github/workflows/test_python_workflow.yml

@@ -58,8 +58,12 @@ jobs:
           cache: 'pip'
       - name: Install Python dependencies
         run: |
+          echo "Installing test dependencies..."
           python -m pip install pytest tox
           python -m pip install -e examples/netflow
+          python -m pip install black
+          echo "Installing linting dependencies from cache..."
+          python -m pip install maturin mypy networkx pyvis pandas-stubs
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -78,6 +82,22 @@ jobs:
         if: matrix.os == 'ubuntu-latest' && matrix.python == '3.13'
         run: |
           python docs/scripts/gen_docs_graphql_pages.py
+      - name: Run python linter
+        if: matrix.os == 'ubuntu-latest' && matrix.python == '3.13'
+        run: |
+          cd python && black .
+      - name: Run stubsgen
+        if: matrix.os == 'ubuntu-latest' && matrix.python == '3.13'
+        run: |
+          echo "Installing Raphtory from cache..."
+          pip install raphtory
+          echo "Installing stubsgen"
+          python -m pip install -e stub_gen
+          cd python/scripts && python gen-stubs.py
+      - name: Run mypy
+        run: |
+          mypy -m raphtory
+
       - name: Check for uncommitted changes
 
         if: matrix.os == 'ubuntu-latest' && matrix.python == '3.13'

docs/reference/graphql/graphql_API.md

@@ -1896,43 +1896,43 @@ Export all nodes and edges from this graph view to another existing graph
 </thead>
 <tbody>
 <tr>
-<td colspan="2" valign="top"><strong id="graphalgorithmplugin.shortest_path">shortest_path</strong></td>
-<td valign="top">[<a href="#shortestpathoutput">ShortestPathOutput</a>!]!</td>
+<td colspan="2" valign="top"><strong id="graphalgorithmplugin.pagerank">pagerank</strong></td>
+<td valign="top">[<a href="#pagerankoutput">PagerankOutput</a>!]!</td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">source</td>
-<td valign="top"><a href="#string">String</a>!</td>
+<td colspan="2" align="right" valign="top">iterCount</td>
+<td valign="top"><a href="#int">Int</a>!</td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">targets</td>
-<td valign="top">[<a href="#string">String</a>!]!</td>
+<td colspan="2" align="right" valign="top">threads</td>
+<td valign="top"><a href="#int">Int</a></td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">direction</td>
-<td valign="top"><a href="#string">String</a></td>
+<td colspan="2" align="right" valign="top">tol</td>
+<td valign="top"><a href="#float">Float</a></td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" valign="top"><strong id="graphalgorithmplugin.pagerank">pagerank</strong></td>
-<td valign="top">[<a href="#pagerankoutput">PagerankOutput</a>!]!</td>
+<td colspan="2" valign="top"><strong id="graphalgorithmplugin.shortest_path">shortest_path</strong></td>
+<td valign="top">[<a href="#shortestpathoutput">ShortestPathOutput</a>!]!</td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">iterCount</td>
-<td valign="top"><a href="#int">Int</a>!</td>
+<td colspan="2" align="right" valign="top">source</td>
+<td valign="top"><a href="#string">String</a>!</td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">threads</td>
-<td valign="top"><a href="#int">Int</a></td>
+<td colspan="2" align="right" valign="top">targets</td>
+<td valign="top">[<a href="#string">String</a>!]!</td>
 <td></td>
 </tr>
 <tr>
-<td colspan="2" align="right" valign="top">tol</td>
-<td valign="top"><a href="#float">Float</a></td>
+<td colspan="2" align="right" valign="top">direction</td>
+<td valign="top"><a href="#string">String</a></td>
 <td></td>
 </tr>
 </tbody>