TSPS-348 part two: remove teaspoons-cli dir and contents

.github/workflows/release-python-client.yml

@@ -0,0 +1,76 @@
+name: Build and publish Python client to PyPI
+
+on:
+  pull_request:
+  workflow_call:
+    inputs:
+      new-tag:
+        required: true
+        type: string
+jobs:
+  params-gen:
+    runs-on: ubuntu-latest
+    outputs:
+      new-tag: ${{ steps.generate-params.outputs.new-tag }}
+    steps:
+      - name: Get inputs or use defaults
+        id: generate-params
+        run: |
+          if [ -z ${{ inputs.new-tag }} ]; then
+            echo "No new tag provided; will run through tasks, but ultimately will not overwrite PyPi version '0.0.0'"
+            echo "new-tag='0.0.0'" >> $GITHUB_OUTPUT
+          else
+            echo "New tag provided: ${{ inputs.new-tag }}"
+            echo "new-tag=${{ inputs.new-tag }}" >> $GITHUB_OUTPUT
+          fi
+
+  build-n-publish:
+    name: Build and publish Python client to PyPI
+    needs: [ params-gen ]
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing (OIDC)
+      # https://docs.pypi.org/trusted-publishers/using-a-publisher/
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install openapi-generator-cli
+        run: npm install @openapitools/openapi-generator-cli -g
+
+      - name: set version to 7.9.0
+        run: openapi-generator-cli version-manager set 7.9.0
+
+      - name: Generate Python client
+        run: |
+          echo "Generating Python client for version ${{ needs.params-gen.outputs.new-tag }}"
+          openapi-generator-cli generate \
+          -i common/openapi.yml \
+          -g python \
+          -o teaspoons-client \
+          --additional-properties=projectName=terra-scientific-pipelines-service-api-client,packageName=teaspoons_client,packageVersion=${{ needs.params-gen.outputs.new-tag }},httpUserAgent=terra-scientific-pipelines-service-api-client/${{ needs.params-gen.outputs.new-tag }}/python
+
+      - name: Install pypa/build
+        working-directory: ./teaspoons-client
+        run: >-
+          python -m pip install build --user
+
+      - name: Build a binary wheel and a source tarball
+        working-directory: ./teaspoons-client
+        run: >-
+          python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages_dir: ./teaspoons-client/dist
+          skip_existing: true
+          attestations: false  # https://github.com/pypa/gh-action-pypi-publish/discussions/255

.github/workflows/tag-publish.yml

@@ -1,9 +1,10 @@
 name: Bump, Tag, Publish, and Deploy
 # The purpose of the workflow is to:
 #  1. Bump the version number and tag the release
-#  2. Build and publish the client to Artifactory
-#  3. Build docker image and publish to GCR
-#  4. Trigger deployment to the dev environment
+#  2. Build and publish the python client to PyPi
+#  3. Build and publish the client to Artifactory
+#  4. Build docker image and publish to GCR
+#  5. Trigger deployment to the dev environment
 #
 # When run on merge to main, it tags and bumps the patch version by default. You can
 # bump other parts of the version by putting #major, #minor, or #patch in your commit
@@ -66,15 +67,12 @@ jobs:
         with:
           event-name: ${{ github.event_name }}
 
-  tag-publish-docker-deploy:
+  tag-job:
     needs: [ bump-check ]
     runs-on: ubuntu-latest
-    permissions:
-      contents: 'write'
-      id-token: 'write'
     if: needs.bump-check.outputs.is-bump == 'no'
     outputs:
-      tag: ${{ steps.tag.outputs.tag }}
+      tag: ${{ steps.tag.outputs.new_tag }}
     steps:
       - name: Set part of semantic version to bump
         id: controls
@@ -97,7 +95,8 @@ jobs:
           token: ${{ secrets.BROADBOT_TOKEN }}
 
       - name: Bump the tag to a new version
-        uses: databiosphere/github-actions/actions/[email protected]
+        # https://github.com/DataBiosphere/github-actions/tree/master/actions/bumper
+        uses: databiosphere/github-actions/actions/[email protected]
         id: tag
         env:
           DEFAULT_BUMP: patch
@@ -109,12 +108,34 @@ jobs:
           VERSION_LINE_MATCH: "^gradle.ext.releaseVersion\\s*=\\s*\".*\""
           VERSION_SUFFIX: SNAPSHOT
 
+   # Publish Python client to PyPI
+  python-client-job:
+    needs: [ tag-job ]
+    uses: ./.github/workflows/release-python-client.yml
+    if: ${{ github.event_name != 'pull_request' }}
+    with:
+      new-tag: ${{ needs.tag-job.outputs.tag }}
+
+  # Publish the Java client to Artifactory and deploy the docker image to GCR
+  publish-docker-deploy:
+    needs: [ tag-job ]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: 'write'
+      id-token: 'write'
+    steps:
       - name: Set up AdoptOpenJDK
         uses: actions/setup-java@v2
         with:
           distribution: 'temurin'
           java-version: 17
 
+      - name: Checkout current code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ steps.controls.outputs.checkout-branch }}
+          token: ${{ secrets.BROADBOT_TOKEN }}
+
       - name: Cache Gradle packages
         uses: actions/cache@v2
         with:
@@ -127,8 +148,8 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
-      # Publish client to artifactory
-      - name: Publish to Artifactory
+      # Publish Java client to artifactory
+      - name: Publish Java client to Artifactory
         if: ${{ github.event_name != 'pull_request' }}
         run: ./gradlew :client:artifactoryPublish --scan
         env:
@@ -153,7 +174,7 @@ jobs:
 
       - name: Construct docker image name and tag
         id: image-name
-        run: echo ::set-output name=name::${GOOGLE_DOCKER_REPOSITORY}/${GOOGLE_PROJECT}/${SERVICE_NAME}/${IMAGE_NAME}:${{ steps.tag.outputs.tag }}
+        run: echo ::set-output name=name::${GOOGLE_DOCKER_REPOSITORY}/${GOOGLE_PROJECT}/${SERVICE_NAME}/${IMAGE_NAME}:${{ needs.tag-job.outputs.tag }}
 
       - name: Build image locally with jib
         run: |
@@ -169,7 +190,7 @@ jobs:
         uses: ncipollo/release-action@v1
         id: create_release
         with:
-          tag: ${{ steps.tag.outputs.tag }}
+          tag: ${{ needs.tag-job.outputs.tag }}
 
       - name: Notify slack on failure
         uses: broadinstitute/[email protected]
@@ -187,22 +208,22 @@ jobs:
   report-to-sherlock:
     # Report new Teaspoons version to Broad DevOps
     uses: broadinstitute/sherlock/.github/workflows/client-report-app-version.yaml@main
-    needs: [ bump-check, tag-publish-docker-deploy ]
+    needs: [ bump-check, tag-job, publish-docker-deploy ]
     if: ${{ needs.bump-check.outputs.is-bump == 'no' }}
     with:
-      new-version: ${{ needs.tag-publish-docker-deploy.outputs.tag }}
+      new-version: ${{ needs.tag-job.outputs.tag }}
       chart-name: 'tsps'
     permissions:
       contents: 'read'
       id-token: 'write'
-  
+
   set-version-in-dev:
     # Put new Teaspoons version in Broad dev environment
     uses: broadinstitute/sherlock/.github/workflows/client-set-environment-app-version.yaml@main
-    needs: [ bump-check, tag-publish-docker-deploy, report-to-sherlock ]
+    needs: [ bump-check, tag-job, report-to-sherlock ]
     if: ${{ needs.bump-check.outputs.is-bump == 'no' && github.event_name != 'pull_request' }}
     with:
-      new-version: ${{ needs.tag-publish-docker-deploy.outputs.tag }}
+      new-version: ${{ needs.tag-job.outputs.tag }}
       chart-name: 'tsps'
       environment-name: 'dev'
     secrets:

README.md

@@ -71,7 +71,7 @@ GOOGLE_APPLICATION_CREDENTIALS=config/tsps-sa.json in the Run/Debug configuratio
   - Run `./gradlew spotlessCheck` to run linter checks 
   - Run `./gradlew :service:spotlessApply` to apply fix any issues the linter finds
 
-## (Optional) Install pre-commit hooks
+### (Optional) Install pre-commit hooks
 1. [scripts/git-hooks/pre-commit] has been provided to help ensure all submitted changes are formatted correctly.  To install all hooks in [scripts/git-hooks], run:
 ```bash
 git config core.hooksPath scripts/git-hooks
@@ -146,3 +146,14 @@ To run the test against a specific feature branch:
  - If you've updated the end-to-end test in the dsp-resuable-workflows repo, enter either a commit hash or your git 
 branch name. If you don't need to change the test, leave the default as main.
 4. Click the green "Run workflow" button.
+
+## Python clients
+We publish a "thin", auto-generated Python client that wraps the Teaspoons APIs. This client is published to 
+[PyPi](https://pypi.org/project/terra-scientific-pipelines-service-api-client/) and can be installed with 
+`pip install teaspoons_client`, although this is not meant to be user-facing. The thin api client is generated from 
+the OpenAPI spec in the `openapi` directory. 
+
+Publishing occurs automatically when a new version of the service is deployed, via the 
+[release-python-client GHA](https://github.com/DataBiosphere/terra-scientific-pipelines-service/blob/main/.github/workflows/release-python-client.yml). 
+
+We also have a user-facing, "thick" CLI whose code lives in a separate repository: [DataBiosphere/terra-scientific-pipelines-service-cli](https://github.com/DataBiosphere/terra-scientific-pipelines-service-cli).