Various improvements to the SDK generation process (cvat-ai#5678)

Author: SpecLad

.github/workflows/full.yml

@@ -78,9 +78,7 @@ jobs:
             --entrypoint /bin/bash -u root cvat/server \
             -c 'python manage.py spectacular --file /transfer/schema.yml'
           pip3 install --user -r cvat-sdk/gen/requirements.txt
-          cd cvat-sdk/
-          gen/generate.sh
-          cd ..
+          ./cvat-sdk/gen/generate.sh
 
           cp -r cvat-sdk/* /tmp/cvat_sdk/
 

.github/workflows/helm.yml

@@ -72,9 +72,7 @@ jobs:
         kubectl exec $(kubectl get pods -l component=server -o jsonpath='{.items[0].metadata.name}') -- /bin/bash -c "python manage.py spectacular --file /tmp/schema.yml"
         kubectl cp $(kubectl get pods -l component=server -o jsonpath='{.items[0].metadata.name}'):/tmp/schema.yml cvat-sdk/schema/schema.yml
         pip3 install --user -r cvat-sdk/gen/requirements.txt
-        cd cvat-sdk/
-        gen/generate.sh
-        cd ..
+        ./cvat-sdk/gen/generate.sh
 
     - name: Install test requirements
       run: |

.github/workflows/main.yml

@@ -79,9 +79,7 @@ jobs:
             --entrypoint /bin/bash -u root cvat/server \
             -c 'python manage.py spectacular --file /transfer/schema.yml'
           pip3 install --user -r cvat-sdk/gen/requirements.txt
-          cd cvat-sdk/
-          gen/generate.sh
-          cd ..
+          ./cvat-sdk/gen/generate.sh
 
           cp -r cvat-sdk/* /tmp/cvat_sdk/
 

.github/workflows/schedule.yml

@@ -203,9 +203,7 @@ jobs:
             --entrypoint /bin/bash -u root cvat/server \
             -c 'python manage.py spectacular --file /transfer/schema.yml'
           pip3 install --user -r cvat-sdk/gen/requirements.txt
-          cd cvat-sdk/
-          gen/generate.sh
-          cd ..
+          ./cvat-sdk/gen/generate.sh
 
           pip3 install --user 'cvat-sdk/[pytorch]'
           pip3 install --user cvat-cli/

cvat-sdk/.gitignore

@@ -72,8 +72,6 @@ schema/
 # Generated code
 /cvat_sdk/api_client/
 /cvat_sdk/version.py
-/requirements/
 /docs/
+/requirements/api_client.txt
 /setup.py
-/README.md
-/MANIFEST.in

cvat-sdk/.openapi-generator-ignore

@@ -23,6 +23,7 @@
 #!docs/README.md
 
 # For safety
+/MANIFEST.in
 /cvat_sdk/__init__.py
 /config
 /gen
@@ -31,6 +32,7 @@
 /types.py
 
 # Don't generate these files
+/README.md
 /git_push.sh
 /setup.cfg
 /test-requirements.txt

cvat-sdk/.remarkignore

@@ -1,2 +1 @@
 cvat-sdk/docs/
-cvat-sdk/README.md

cvat-sdk/gen/templates/MANIFEST.in cvat-sdk/MANIFEST.in

@@ -11,42 +11,39 @@ GENERATOR_VERSION="v6.0.1"
 VERSION="2.3.0"
 LIB_NAME="cvat_sdk"
 LAYER1_LIB_NAME="${LIB_NAME}/api_client"
-DST_DIR="."
-TEMPLATE_DIR="gen"
+DST_DIR="$(cd "$(dirname -- "$0")/.." && pwd)"
+TEMPLATE_DIR_NAME="gen"
+TEMPLATE_DIR="$DST_DIR/$TEMPLATE_DIR_NAME"
 POST_PROCESS_SCRIPT="${TEMPLATE_DIR}/postprocess.py"
 
-mkdir -p "${DST_DIR}/"
-rm -f -r "${DST_DIR}/docs" "${DST_DIR}/${LAYER1_LIB_NAME}" "requirements/"
-cp "${TEMPLATE_DIR}/templates/openapi-generator/.openapi-generator-ignore" "${DST_DIR}/"
+rm -f -r "${DST_DIR}/docs" "${DST_DIR}/${LAYER1_LIB_NAME}" \
+    "${DST_DIR}/requirements/api_client.txt"
 
 # Pass template dir here
 # https://github.com/OpenAPITools/openapi-generator/issues/8420
-docker run --rm -v "$PWD":"/local" -u "$(id -u)":"$(id -g)" \
+docker run --rm -v "$DST_DIR:/local" -u "$(id -u)":"$(id -g)" \
     openapitools/openapi-generator-cli:${GENERATOR_VERSION} generate \
-        -t "/local/${TEMPLATE_DIR}/templates/openapi-generator/" \
+        -t "/local/${TEMPLATE_DIR_NAME}/templates/openapi-generator/" \
         -i "/local/schema/schema.yml" \
-        --config "/local/${TEMPLATE_DIR}/generator-config.yml" \
+        --config "/local/${TEMPLATE_DIR_NAME}/generator-config.yml" \
+        -p "packageVersion=$VERSION" \
         -g python \
-        -o "/local/${DST_DIR}/"
+        -o "/local/"
 
-sed -e "s|{{packageVersion}}|${VERSION}|g" "${TEMPLATE_DIR}/templates/version.py.template" > "${DST_DIR}/${LIB_NAME}/version.py"
-cp -r "${TEMPLATE_DIR}/templates/requirements" "${DST_DIR}/"
-cp -r "${TEMPLATE_DIR}/templates/MANIFEST.in" "${DST_DIR}/"
+echo "VERSION = \"$VERSION\"" > "${DST_DIR}/${LIB_NAME}/version.py"
 mv "${DST_DIR}/requirements.txt" "${DST_DIR}/requirements/api_client.txt"
 
 # Do custom postprocessing for code files
-"${POST_PROCESS_SCRIPT}" --schema "schema/schema.yml" --input-path "${DST_DIR}/${LIB_NAME}"
+"${POST_PROCESS_SCRIPT}" --schema "${DST_DIR}/schema/schema.yml" \
+    --input-path "${DST_DIR}/${LIB_NAME}"
 
 # Do custom postprocessing for docs files
-"${POST_PROCESS_SCRIPT}" --schema "schema/schema.yml" --input-path "${DST_DIR}/docs" --file-ext '.md'
-"${POST_PROCESS_SCRIPT}" --schema "schema/schema.yml" --input-path "${DST_DIR}/README.md"
+"${POST_PROCESS_SCRIPT}" --schema "${DST_DIR}/schema/schema.yml" \
+    --input-path "${DST_DIR}/docs" --file-ext '.md'
 
 API_DOCS_DIR="${DST_DIR}/docs/apis/"
 MODEL_DOCS_DIR="${DST_DIR}/docs/models/"
 mkdir "${API_DOCS_DIR}"
 mkdir "${MODEL_DOCS_DIR}"
 mv "${DST_DIR}/docs/"*Api.md "${API_DOCS_DIR}"
 mv "${DST_DIR}/docs/"*.md "${MODEL_DOCS_DIR}"
-mv "${DST_DIR}/README.md" "${DST_DIR}/docs/"
-
-cp "${TEMPLATE_DIR}/templates/README.md.template" "${DST_DIR}/README.md"

cvat-sdk/gen/templates/README.md.template cvat-sdk/README.md

@@ -1,6 +1,5 @@
 additionalProperties:
   projectName: "cvat_sdk"
-  packageVersion: "2.0-alpha"
   packageUrl: "https://github.com/cvat-ai/cvat"
   packageName: "cvat_sdk.api_client"
   initRequiredVars: true

cvat-sdk/gen/generate.sh

@@ -161,6 +161,8 @@ def main(args=None):
         processor.process_dir(args.input_path, file_ext=args.file_ext)
     elif osp.isfile(args.input_path):
         processor.process_file(args.input_path)
+    else:
+        return f"error: input {args.input_path} is neither a file nor a directory"
 
     return 0