Restructure workflows

.github/workflows/publish-docs.yml

@@ -22,11 +22,10 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install -e .[vis]
+          pip install -e .[vis,doc]
 
       - name: Build docs
         run: |
-          pip install sphinx sphinx_rtd_theme myst-parser sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page
           sphinx-build -b html docs/ ./public
           cp -r docs/additional_resources/* ./public/
 

.github/workflows/test-main.yml → .github/workflows/run-tests.yml

@@ -1,17 +1,15 @@
-name: Test main branch 🧪
+name: Test 🧪
 
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+on: [push, pull_request]
 
 jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Test on oldest and newest supported Python versions
+        python-version: ["3.8", "3.12"]
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
@@ -20,22 +18,20 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: ${{ matrix.python-version }}
 
       - name: Upgrade pip
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
 
       - name: Install dependencies
         run: |
-          pip install numpy pytest coverage pytest-mock
-          pip install -e .[vis]
+          pip install -e .[vis,test]
 
       - name: Run tests with pytest
         run: coverage run --source pathfinding3d -m pytest 
 
-      - name: Show basic test coverage report
+      - name: Generate coverage reports
         run: |
           coverage report -m
           coverage xml

.github/workflows/test-and-publish-release.yml

@@ -25,13 +25,12 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install numpy pytest coverage pytest-mock
-          pip install -e .[vis]
+          pip install -e .[vis,test,doc]
 
       - name: Run tests with pytest
         run: coverage run --source pathfinding3d -m pytest 
 
-      - name: Show basic test coverage report
+      - name: Generate coverage reports
         run: |
           coverage report -m
           coverage xml
@@ -46,7 +45,6 @@ jobs:
 
       - name: Build docs
         run: |
-          pip install sphinx sphinx_rtd_theme myst-parser sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page
           sphinx-build -b html docs/ ./public
           cp -r docs/additional_resources/* ./public/
 

README.md

@@ -4,7 +4,7 @@
 
 [![MIT License](https://img.shields.io/github/license/harisankar95/pathfinding3d)](LICENSE)
 [![PyPI](https://img.shields.io/pypi/v/pathfinding3d)](https://pypi.org/project/pathfinding3d/)
-[![Pipeline](https://github.com/harisankar95/pathfinding3D/actions/workflows/test-main.yml/badge.svg?branch=main)](https://github.com/harisankar95/pathfinding3D/actions/workflows/test-main.yml)
+[![Pipeline](https://github.com/harisankar95/pathfinding3D/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/harisankar95/pathfinding3D/actions/workflows/run-tests.yml)
 [![codecov](https://codecov.io/gh/harisankar95/pathfinding3D/branch/main/graph/badge.svg?token=ZQZQZQZQZQ)](https://codecov.io/gh/harisankar95/pathfinding3D)
 [![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Documentation](https://img.shields.io/badge/documentation-view-blue)](https://harisankar95.github.io/pathfinding3D/INTRO.html)

setup.py

@@ -7,6 +7,23 @@
 with open(os.path.join("pathfinding3d", "version.txt"), encoding="utf-8") as file_handler:
     __version__ = file_handler.read().strip()
 
+# Test requirements
+test_requirements = [
+    "pytest",
+    "pytest-cov",
+    "pytest-mock",
+]
+# Documentation requirements
+doc_requirements = [
+    "sphinx",
+    "sphinx_rtd_theme",
+    "myst-parser",
+    "sphinx-autodoc-typehints",
+    "sphinx-copybutton",
+    "sphinx-prompt",
+    "sphinx-notfound-page",
+]
+
 setup(
     name="pathfinding3d",
     description="Pathfinding algorithms in 3D grids (based on python-pathfinding)",
@@ -26,25 +43,12 @@
     package_data={"pathfinding3d": ["version.txt"]},
     install_requires=["numpy"],
     extras_require={
-        "dev": [
-            "black",
-            "pytest",
-            "pytest-mock",
-            "coverage",
-            "sphinx<=7.2.6",
-            "sphinx_rtd_theme",
-            "myst-parser",
-            "sphinx-autodoc-typehints",
-            "sphinx-copybutton",
-            "sphinx-prompt",
-            "sphinx-notfound-page",
-        ],
         "vis": ["plotly"],
+        "dev": ["black"] + test_requirements + doc_requirements,
+        "test": test_requirements,
+        "doc": doc_requirements,
     },
-    tests_require=[
-        "pytest",
-        "coverage",
-    ],
+    tests_require=test_requirements,
     python_requires=">=3.8",
     platforms=["any"],
 )