fix(build): introduce poetry as build tool

This commit updates the project to use poetry as a tool
for building and publishing the project.

Signed-off-by: Phil Adams <[email protected]>

Author: padamstx

.github/workflows/build.yaml

@@ -55,6 +55,12 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install Poetry
+        run: |
+          apt install pipx
+          pipx ensurepath --global
+          pipx install poetry
+
       - name: Build & Test
         run: make ci
 

.github/workflows/publish.yaml

@@ -25,10 +25,16 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.13
+      
+      - name: Install Poetry
+        run: |
+          apt install pipx
+          pipx ensurepath --global
+          pipx install poetry
 
       - name: Build and publish distribution
         env:
-          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
         run: |
           make ci
           make publish-release

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2025-01-09T22:39:35Z",
+  "generated_at": "2025-05-19T21:05:36Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -82,19 +82,29 @@
         "hashed_secret": "a2190c299b60e882d9fb33736d5e6ab6ffe42708",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 939,
+        "line_number": 948,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "cf4d2385b84329a52ca542285b93d9c4618420df",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1618,
+        "line_number": 1627,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ],
+    "poetry.lock": [
+      {
+        "hashed_secret": "6888d6c14621a80f6ed98f5ebfe99de740de3f1c",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 796,
+        "type": "Hex High Entropy String",
+        "verified_result": null
+      }
+    ],
     "test/integration/test_catalog_management_v1_old.py": [
       {
         "hashed_secret": "178fb14190d81e76cb90c5f64b7e4655e24f621c",
@@ -120,15 +130,15 @@
         "hashed_secret": "a2190c299b60e882d9fb33736d5e6ab6ffe42708",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1148,
+        "line_number": 1223,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "cf4d2385b84329a52ca542285b93d9c4618420df",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1702,
+        "line_number": 1777,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -270,31 +280,31 @@
         "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1575,
+        "line_number": 1574,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "cf4d2385b84329a52ca542285b93d9c4618420df",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 4055,
+        "line_number": 4057,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "469f62fa9e1c6afe62e8808180668934ee548e8f",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 9511,
+        "line_number": 9921,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 10632,
+        "line_number": 11125,
         "type": "Secret Keyword",
         "verified_result": null
       }

Makefile

@@ -1,38 +1,24 @@
-# This makefile is used to make it easier to get the project set up
-# to be ready for development work in the local sandbox.
-# example: "make setup"
-
 PYTHON=python
 LINT=black
+POETRY=poetry
 LINT_DIRS=ibm_platform_services test/unit test/integration examples
 
-setup: deps dev-deps install-project
-
-all: upgrade-pip setup test-unit lint
+all: upgrade-pip deps test-unit lint
 
 ci: all
 
-publish-release: publish-deps build-dist publish-dist
+publish-release: build-dist publish-dist
 
 upgrade-pip:
 	${PYTHON} -m pip install --upgrade pip
 
 deps:
-	${PYTHON} -m pip install .
-
-dev-deps:
-	${PYTHON} -m pip install .[dev]
+	${POETRY} install
 
 detect-secrets:
 	detect-secrets scan --update .secrets.baseline
 	detect-secrets audit .secrets.baseline
 
-publish-deps:
-	${PYTHON} -m pip install .[publish]
-
-install-project:
-	${PYTHON} -m pip install -e .
-
 test: test-unit test-int
 
 test-unit:
@@ -52,9 +38,8 @@ lint-fix:
 	${LINT} ${LINT_DIRS}
 
 build-dist:
-	rm -fr dist
-	${PYTHON} -m build
+	${POETRY} build --clean
 
-# This target requires the TWINE_PASSWORD env variable to be set to the user's pypi.org API token.
+# This target requires the POETRY_PYPI_TOKEN_PYPI env variable to be set to the user's pypi.org API token.
 publish-dist:
-	TWINE_USERNAME=__token__ ${PYTHON} -m twine upload --non-interactive --verbose dist/*
+	${POETRY} publish --dry-run