feat(python): improve automation for python sdk generation, added CI for release, rename package for kestrapy

Author: Skraye

.github/workflows/python-sdk.yml

@@ -0,0 +1,60 @@
+name: Python SDK release
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+  workflow_dispatch:
+    inputs:
+      skip-test:
+        description: 'Skip test'
+        required: false
+        type: string
+        default: "false"
+
+jobs:
+  pip:
+    name: Publish to Pip
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./python-sdk
+    steps:
+      - uses: actions/checkout@v3
+        working-directory: python-sdk
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9.23"
+
+      - name: Install pypa/build
+        working-directory: python
+        run: python -m pip install build --user
+
+      - name: Install deps
+        working-directory: python
+        run: pip install .[test]
+
+      - name: Run unit tests
+        working-directory: python
+        run: pytest
+
+      - name: Build a binary wheel and a source tarball
+        if: startsWith(github.ref, 'refs/tags/v')
+        working-directory: python
+        env:
+          VERSION: ${{ github.ref_name }}
+        run: python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Publish distribution to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true
+          packages-dir: python/dist

README_PYTHON_SDK.md

@@ -4,11 +4,12 @@
 
 1. Update the `kestra-ee.yml` if necessary with latest openspec api changes.
 
-   - As of 13/06/25, `the kestra-ee.yml` has been generated and used without modifications.
-   - Micronaut OpenAPI version `6.16.2` was used, as of 13/06.25, this has not been committed into the core yet (only modified locally).
+   - As of 29/07/25, `the kestra-ee.yml` has been generated and used without modifications.
+   - Micronaut OpenAPI version `6.17.3`
 2. Generate the SDK using the script `generate-sdks.sh` that uses the openapi-generator-cli docker image.
 
-3. Then multiples files changes are needed to be done manually in the generated SDK:
+3.THESE CHANGES ARE DONE AT GENERATION, BUT IF THERE IS AN ERROR, DOUBLE CHECK
+  Then multiples files changes are needed to be done manually in the generated SDK:
    - In the pyproject.toml file, set the following values (you need to replace the current one):
      ```toml
      license = "Apache-2.0"
@@ -19,6 +20,16 @@
      from kestra_api_client.models.list[label] import List[Label]
      ```
 
+  - In the `__init__.py` add the following import, its the custom kestra client that gather all API clients:
+     ```python
+     from kestra_api_client.kestra_client import KestraClient as KestraClient
+     ```
+  - In the `task.py`, delete the following part, from the type validator:
+      ```python
+              if not re.match(r"\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*(\.\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*)*", value):
+            raise ValueError(r"must validate the regular expression /\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*(\.\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*)*/")
+      ```
+
 ## Step to use
 
 The openapi generator will generate 1 Api per controller, so we create a custom Kestra Client that need to be instantiated once for every API.

configurations/python-config.yml

@@ -7,6 +7,6 @@ globalProperties:
   modelTests: false
 
 additionalProperties:
-  packageName: kestra_api_client
-  projectName: kestra_api
+  packageName: kestrapy
+  projectName: kestrapy
   disallowAdditionalPropertiesIfNotPresent: false

generate-sdks.sh

@@ -24,6 +24,11 @@ docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
     -c /local/configurations/python-config.yml \
     --skip-validate-spec \
     --additional-properties=packageVersion=$VERSION
+sed -i 's/^license = .*/license = "Apache-2.0"/' python-sdk/pyproject.toml
+sed -i 's/^requires-python = .*/requires-python = ">=3.9"/' python-sdk/pyproject.toml
+sed -i '/from kestra_api_client\.models\.list\[label\] import List\[Label\]/d' python-sdk/kestra_api_client/api/executions_api.py
+grep -vF '{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}' python-sdk/kestra_api_client/models/task.py > temp_file && mv temp_file python-sdk/kestra_api_client/models/task.py
+echo "from kestra_api_client.kestra_client import KestraClient as KestraClient" >> python-sdk/kestra_api_client/__init__.py
 fi
 
 # Generate Javascript SDK