chore: add CI workflow (#46)

Author: Hartorn

.github/workflows/ci.yml

@@ -0,0 +1,79 @@
+
+name: Full CI
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pre_checks:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+  
+      - name: Set up python
+        id: setup-python
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5
+        with:
+            python-version: "3.10"
+  
+      - name: Install Poetry
+        uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a # v1
+        with:
+            virtualenvs-create: true
+            virtualenvs-in-project: true
+            installer-parallel: true
+  
+      - name: Install deps & build base images
+        run: make setup
+  
+      - name: Check format
+        run: make check_format
+  
+      - name: Check linting
+        run: make check_linting
+
+      - name: Make sure doc is building
+        run: make doc
+  
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false # Do not stop when any job fails
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up python
+      id: setup-python
+      uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5
+      with:
+          python-version: "${{ matrix.python-version }}"
+
+    - name: Install Poetry
+      uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a # v1
+      with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+    - name: Install deps & build base images
+      run: make setup
+
+    - name: Run the tests
+      run: make test

Makefile

@@ -16,6 +16,11 @@ format: ## Format all files inside backend with black & isort
 
 check_linting: ## Verify code with lint tools, like pylint
 	poetry run pylint ./src/giskard_hub
+.PHONY: check_linting
+
+check_format: ## Verify code formatting
+	poetry run black --check .
+	poetry run isort -c .
 .PHONY: check_format
 
 setup: ## Install dependencies
@@ -33,4 +38,8 @@ quick-doc: ## Build the doc & serve it locally
 	cp ./README.md ./script-docs/README.md
 	cd ./script-docs && rm -rf _build && poetry run make html
 	poetry run python3 -m http.server --directory ./script-docs/_build/html/
-.PHONY: quick-doc
+.PHONY: quick-doc
+
+test: ## Launch unit tests
+	poetry run pytest -vvv ./tests
+.PHONY: test

examples/example.ipynb

@@ -17,10 +17,7 @@
     "from giskard_hub.client import HubClient\n",
     "\n",
     "# Initialise hub client\n",
-    "hub = HubClient(\n",
-    "    api_key=\"YOUR_API_KEY\",\n",
-    "    hub_url=\"http://your-hub-instance.com/_api\"\n",
-    ")\n",
+    "hub = HubClient(api_key=\"YOUR_API_KEY\", hub_url=\"http://your-hub-instance.com/_api\")\n",
     "\n",
     "# api_key and hub url can also be provided by setting env variable GSK_API_KEY and GSK_HUB_URL"
    ]