DGL Refactor Updates (#31)

* initial commit * bump * cleanup workflows * Update build.yml * Update build.yml * parameter renaming, new `use_async` param * update release action
arangoml · Oct 26, 2023 · 2178ac0 · 2178ac0
1 parent b470e85
commit 2178ac0
Show file tree

Hide file tree

Showing 7 changed files with 759 additions and 456 deletions.
diff --git a/.github/workflows/analyze.yml b/.github/workflows/analyze.yml
@@ -37,7 +37,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,9 +1,8 @@
 name: build
 on:
   workflow_dispatch:
-  push:
-    branches: [ master ]
   pull_request:
+  push:
     branches: [ master ]
 env:
   PACKAGE_DIR: adbdgl_adapter
@@ -16,31 +15,44 @@ jobs:
         python: ["3.8", "3.9", "3.10", "3.11"]
     name: Python ${{ matrix.python }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
       - name: Setup Python ${{ matrix.python }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
+          cache: 'pip'
+          cache-dependency-path: setup.py
+
       - name: Set up ArangoDB Instance via Docker
-        run: docker create --name adb -p 8529:8529 -e ARANGO_ROOT_PASSWORD= arangodb/arangodb:3.9.1
+        run: docker create --name adb -p 8529:8529 -e ARANGO_ROOT_PASSWORD= arangodb/arangodb
+
       - name: Start ArangoDB Instance
         run: docker start adb
+
       - name: Setup pip
         run: python -m pip install --upgrade pip setuptools wheel
+
       - name: Install packages
         run: pip install .[dev]
+
       - name: Run black
         run: black --check --verbose --diff --color ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
+
       - name: Run flake8
         run: flake8 ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
+
       - name: Run isort
         run: isort --check --profile=black ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
+
       - name: Run mypy
         run: mypy ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
+
       - name: Run pytest
         run: pytest --cov=${{env.PACKAGE_DIR}} --cov-report xml --cov-report term-missing -v --color=yes --no-cov-on-fail --code-highlight=yes
+
       - name: Publish to coveralls.io
-        if: matrix.python == '3.8'
+        if: matrix.python == '3.10'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: coveralls --service=github
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -3,76 +3,34 @@ on:
   workflow_dispatch:
   release:
     types: [published]
-env:
-  PACKAGE_DIR: adbdgl_adapter
-  TESTS_DIR: tests
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python: ["3.8", "3.9", "3.10", "3.11"]
-    name: Python ${{ matrix.python }}
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python ${{ matrix.python }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python }}
-      - name: Set up ArangoDB Instance via Docker
-        run: docker create --name adb -p 8529:8529 -e ARANGO_ROOT_PASSWORD= arangodb/arangodb:3.9.1
-      - name: Start ArangoDB Instance
-        run: docker start adb
-      - name: Setup pip
-        run: python -m pip install --upgrade pip setuptools wheel
-      - name: Install packages
-        run: pip install .[dev]
-      - name: Run black
-        run: black --check --verbose --diff --color ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
-      - name: Run flake8
-        run: flake8 ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
-      - name: Run isort
-        run: isort --check --profile=black ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
-      - name: Run mypy
-        run: mypy ${{env.PACKAGE_DIR}} ${{env.TESTS_DIR}}
-      - name: Run pytest
-        run: pytest --cov=${{env.PACKAGE_DIR}} --cov-report xml --cov-report term-missing -v --color=yes --no-cov-on-fail --code-highlight=yes
-      - name: Publish to coveralls.io
-        if: matrix.python == '3.8'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: coveralls --service=github
-
   release:
-    needs: build
     runs-on: ubuntu-latest
     name: Release package
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Fetch complete history for all tags and branches
         run: git fetch --prune --unshallow
 
-      - name: Setup python
-        uses: actions/setup-python@v2
+      - name: Setup Python
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.8"
+          python-version: "3.10"
 
       - name: Install release packages
         run: pip install setuptools wheel twine setuptools-scm[toml]
 
-      - name: Install dependencies
-        run: pip install .[dev]
-
       - name: Build distribution
         run: python setup.py sdist bdist_wheel
 
-      - name: Publish to PyPI Test
+      - name: Publish to Test PyPi
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD_TEST }}
         run: twine upload --repository testpypi dist/* #--skip-existing
-      - name: Publish to PyPI
+
+      - name: Publish to PyPi
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
@@ -83,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Update Changelog
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -95,10 +53,10 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Setup python
-        uses: actions/setup-python@v2
+      - name: Setup Python
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.8"
+          python-version: "3.10"
 
       - name: Install release packages
         run: pip install wheel gitchangelog pystache
@@ -110,12 +68,12 @@ jobs:
         run: gitchangelog ${{env.VERSION}} > CHANGELOG.md
 
       - name: Make commit for auto-generated changelog
-        uses: EndBug/add-and-commit@v7
+        uses: EndBug/add-and-commit@v9
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           add: "CHANGELOG.md"
-          branch: actions/changelog
+          new_branch: actions/changelog
           message: "!gitchangelog"
 
       - name: Create pull request for the auto generated changelog
@@ -128,4 +86,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Alert developer of open PR
-        run: echo "Changelog $PR_URL is ready to be merged by developer."
+        run: echo "Changelog $PR_URL is ready to be merged by developer."
diff --git a/adbdgl_adapter/abc.py b/adbdgl_adapter/abc.py
@@ -15,16 +15,18 @@ def __init__(self) -> None:
         raise NotImplementedError  # pragma: no cover
 
     def arangodb_to_dgl(
-        self, name: str, metagraph: ADBMetagraph, **query_options: Any
+        self, name: str, metagraph: ADBMetagraph, **adb_export_kwargs: Any
     ) -> DGLHeteroGraph:
         raise NotImplementedError  # pragma: no cover
 
     def arangodb_collections_to_dgl(
-        self, name: str, v_cols: Set[str], e_cols: Set[str], **query_options: Any
+        self, name: str, v_cols: Set[str], e_cols: Set[str], **adb_export_kwargs: Any
     ) -> DGLHeteroGraph:
         raise NotImplementedError  # pragma: no cover
 
-    def arangodb_graph_to_dgl(self, name: str, **query_options: Any) -> DGLHeteroGraph:
+    def arangodb_graph_to_dgl(
+        self, name: str, **adb_export_kwargs: Any
+    ) -> DGLHeteroGraph:
         raise NotImplementedError  # pragma: no cover
 
     def dgl_to_arangodb(
@@ -34,7 +36,7 @@ def dgl_to_arangodb(
         metagraph: DGLMetagraph = {},
         explicit_metagraph: bool = True,
         overwrite_graph: bool = False,
-        **import_options: Any,
+        **adb_import_kwargs: Any,
     ) -> ArangoDBGraph:
         raise NotImplementedError  # pragma: no cover