Test & CI

Author: sim51

.github/build.yml

@@ -0,0 +1,29 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+
+      - name: Install dependencies with Poetry
+        run: poetry install --with dev
+
+      - name: Build
+        run: poetry build
+
+      - name: Tests
+        run: poetry run pytest

.gitignore

@@ -1,4 +1,5 @@
 dist
 __pycache__
 .pytest_cache
-gephi-toolkit-all.jar
+gephi-toolkit-all.jar
+test-export-graph.*

README.md

@@ -8,12 +8,11 @@ It provides helpers to easy the use of Gephy toolkit for Pythonist, even if you
 
 * Install the lib `pip install gephipy`
 
-* Initialize the GephiPy context
+* Import gephipy
 
 ```python
 from gephipy import gephipy
 
-gephipy.initialize()
 ```
 
 Then you can use the Gephi toolkit or the GephiPy features.
@@ -22,12 +21,17 @@ Then you can use the Gephi toolkit or the GephiPy features.
 
 ```python
 from gephipy import gephipy
-from org.gephi.statistics.plugin import Modularity, GraphDistance
 
-#
-# Init context
-#
-gephipy.initialize()
+# Java imports must be after the gephipy import
+from org.gephi.layout.plugin.forceAtlas2 import ForceAtlas2Builder
+from org.gephi.layout.plugin.random import Random
+from org.gephi.layout.plugin.noverlap import NoverlapLayoutBuilder
+from org.gephi.statistics.plugin import Modularity, GraphDistance
+from org.openide.util import Lookup
+from org.gephi.appearance.api import AppearanceController
+from org.gephi.appearance.plugin import RankingNodeSizeTransformer, PartitionElementColorTransformer
+from org.gephi.appearance.plugin.palette import PaletteManager
+from org.gephi.statistics.plugin import GraphDistance, Modularity
 
 #
 # Create a workspace

gephipy/gephipy.py

@@ -1,9 +1,12 @@
 import jpype
-
-from pathlib import Path
-import urllib.request
+import jpype.imports
 import networkx as nx
 
+# Starting the JVM
+from gephipy import jvm
+jvm.start()
+
+# Java import
 from java.io import File
 from org.openide.util import Lookup
 from org.gephi.graph.api import GraphController
@@ -12,22 +15,6 @@
 from org.gephi.io.exporter.api import ExportController
 from org.gephi.io.importer.api import ImportController, EdgeDirectionDefault
 
-GTK_URL="https://repo1.maven.org/maven2/org/gephi/gephi-toolkit/0.10.1/gephi-toolkit-0.10.1-all.jar"
-
-#
-# Initialize the context
-#
-def initialize(gephi_jar_path="./gephi-toolkit-all.jar"):
-    gtk_jar = Path(gephi_jar_path)
-    if not gtk_jar.is_file():
-      print("Download the Gephi toolkit jar")
-      urllib.request.urlretrieve(GTK_URL, gephi_jar_path)
-    # Starts the JVM with the GTK in the classpath
-    try:
-      jpype.startJVM(classpath=[gephi_jar_path])
-    except OSError as e: 
-      print(f"Warning: {e}")
-
 #
 # Create a new Gephi workspace
 #

gephipy/jvm.py

@@ -3,18 +3,40 @@
 from pathlib import Path
 import urllib.request
 
+started = None
+""" whether the JVM has been started """
+
 GTK_URL="https://repo1.maven.org/maven2/org/gephi/gephi-toolkit/0.10.1/gephi-toolkit-0.10.1-all.jar"
 
+def lol():
+  jpype.startJVM(classpath=["./gephi-toolkit-all.jar"])
+    
 #
 # Initialize the context
 #
-def initialize(gephi_jar_path="./gephi-toolkit-all.jar"):
+def start(gephi_jar_path="./gephi-toolkit-all.jar"):
+  global started
+  print(started)
+  if started is None:
     gtk_jar = Path(gephi_jar_path)
     if not gtk_jar.is_file():
       print("Download the Gephi toolkit jar")
       urllib.request.urlretrieve(GTK_URL, gephi_jar_path)
+    
     # Starts the JVM with the GTK in the classpath
     try:
+      print("start JVM")
       jpype.startJVM(classpath=[gephi_jar_path])
     except OSError as e: 
-      print(f"Warning: {e}")
+      print(f"Warning: {e}")
+    
+    started = True
+    
+def stop():
+  """
+  Kills the JVM.
+  """
+  global started
+  if started is not None:
+    started = None
+    jpype.shutdownJVM()

test/__init__.py

@@ -1,3 +0,0 @@
-from gephipy import jvm
-
-jvm.initialize() 

test/test_scenario.py

@@ -1,8 +1,10 @@
 import pytest
+from pathlib import Path
+import networkx as nx
 
 from gephipy import gephipy 
 
-import networkx as nx
+# Must be imported after gephipy
 from org.gephi.layout.plugin.forceAtlas2 import ForceAtlas2Builder
 from org.gephi.layout.plugin.random import Random
 from org.gephi.layout.plugin.noverlap import NoverlapLayoutBuilder
@@ -13,16 +15,15 @@
 from org.gephi.appearance.plugin.palette import PaletteManager
 from org.gephi.statistics.plugin import GraphDistance, Modularity
 
+
 def test_scenario(): 
-  
   #
   # Create a workspace
   #
   workspace = gephipy.create_workspace()
 
-  #
+  
   # Create a random graph with NetworkX
-  #
   graphX = nx.erdos_renyi_graph(500,0.01)
   gephipy.networkx_to_gephi(workspace, graphX)
   graphModel = gephipy.get_graph_model(workspace)
@@ -65,7 +66,6 @@ def test_scenario():
   partition.setColors(graphModel.getGraph(), palette.getColors())
   appearanceController.transform(colorPartition)
 
-
   #
   # Run Layouts
   #
@@ -94,5 +94,18 @@ def test_scenario():
   #
   # Export your graph
   #
-
-  gephipy.export_gexf(workspace, "my-gephi-graph.gexf")
+  gephipy.export_gexf(workspace, "test-export-graph.gexf")
+  file = Path("./test-export-graph.gexf")
+  assert file.is_file() == True
+    
+  gephipy.export_svg(workspace, "test-export-graph.svg")
+  file = Path("./test-export-graph.svg")
+  assert file.is_file() == True
+    
+  gephipy.export_pdf(workspace, "test-export-graph.pdf")
+  file = Path("./test-export-graph.pdf")
+  assert file.is_file() == True
+    
+  gephipy.export_png(workspace, "test-export-graph.png")
+  file = Path("./test-export-graph.png")
+  assert file.is_file() == True