Merge pull request #12 from qua-platform/add_ci_workflows_description

CI: add workflows description

.github/workflows/build.yaml

@@ -1,7 +1,12 @@
+# This workflow is used for manual (can be triggered via GitHub web interface)
+# build of package archives for distribution. The build workflow 
+# (.github/workflows/reusable-build.yaml) is triggered for creation wheel and 
+# sdist package archives. 
+
 name: Build python package manually
 on:
   workflow_dispatch
 
 jobs:
   build:
-    uses: qua-platform/qualibrate-runner/.github/workflows/reusable-buld.yaml@main
+    uses: qua-platform/qualibrate-runner/.github/workflows/reusable-build.yaml@main

.github/workflows/check.yaml

@@ -1,3 +1,7 @@
+# This workflow is used for automatically running checks on adding commit to 
+# pull requests. This workflow triggers poe (poethepoet) commands: type, lint, 
+# format. The commands are defined in pyproject.toml.
+
 name: Format; lint; type; tests
 on:
   pull_request

.github/workflows/release.yaml

@@ -1,4 +1,9 @@
-name: Create release
+# This workflow is used for creating draft release on GitHub. Firstly the
+# build workflow (.github/workflows/reusable-buld.yaml) is triggered for 
+# creation wheel and sdist package archives. Then the draft GitHub release is
+# created with attached built python package archives.
+
+name: Create draft GitHub release
 
 on:
   push:

.github/workflows/reusable-buld.yaml → .github/workflows/reusable-build.yaml

@@ -1,4 +1,9 @@
-name: Build python package
+# This workflow is used for building qualibrate-runner python package in dist
+# and wheel formats. Built archives is attached to run as artifacts. The 
+# workflow should only be automatically triggered by other workflows (manual 
+# build and release).
+
+name: Reusable build python package (called by other workflows)
 on:
   workflow_call
 jobs:

qualibrate_runner/api/routes.py

@@ -1,4 +1,4 @@
-from typing import Annotated, Any, Mapping, Optional, Type, cast, Sequence
+from typing import Annotated, Any, Mapping, Optional, Sequence, Type, cast
 
 from fastapi import APIRouter, BackgroundTasks, Depends, HTTPException, status
 from pydantic import BaseModel
@@ -145,7 +145,7 @@ def get_graph_cytoscape(
 ) -> Sequence[Mapping[str, Any]]:
     return cast(
         Sequence[Mapping[str, Any]],
-        graph.cytoscape_representation(graph.serialize())
+        graph.cytoscape_representation(graph.serialize()),
     )