Merge pull request #108 from awslabs/feature/pypi-package-rename-orb-py

feat: rename PyPI package to orb-py with namespace support

Author: fgogolli

.github/actions/get-config/action.yml

@@ -19,6 +19,9 @@ outputs:
   is-release:
     description: 'Whether this is a release build'
     value: ${{ steps.config.outputs.is-release }}
+  pypi-name:
+    description: 'PyPI package name'
+    value: ${{ steps.config.outputs.pypi-name }}
 runs:
   using: 'composite'
   steps:
@@ -35,6 +38,7 @@ runs:
         REPO_ORG=$(yq '.repository.org' .project.yml)
         REPO_NAME=$(yq '.repository.name' .project.yml)
         CONTAINER_IMAGE="$REPO_ORG/$REPO_NAME"
+        PYPI_NAME=$(yq '.project.pypi_name' .project.yml)
         
         # Centralized version generation using Makefile infrastructure
         if [[ "${{ github.event_name }}" == "release" ]]; then
@@ -54,6 +58,7 @@ runs:
           echo "container-image=$CONTAINER_IMAGE"
           echo "package-version=$PACKAGE_VERSION"
           echo "is-release=$IS_RELEASE"
+          echo "pypi-name=$PYPI_NAME"
         } >> "$GITHUB_OUTPUT"
         
         echo "Default Python version: $DEFAULT_PYTHON_VERSION"
@@ -62,3 +67,4 @@ runs:
         echo "Container image: $CONTAINER_IMAGE"
         echo "Package version: $PACKAGE_VERSION"
         echo "Is release: $IS_RELEASE"
+        echo "PyPI name: $PYPI_NAME"

.github/workflows/dev-pypi.yml

@@ -1,12 +1,14 @@
-name: PyPI Publishing
+name: TestPyPI Publishing
 
 # SECURITY NOTE: This workflow uses PyPI Trusted Publishing (OIDC)
 # No API tokens required - authentication is handled automatically via GitHub's OIDC token
 #
+# This workflow publishes to TestPyPI ONLY for development testing.
+# Production releases to PyPI are handled by prod-release.yml
+#
 # Prerequisites:
-# 1. Configure trusted publisher on PyPI: https://pypi.org/manage/account/publishing/
-# 2. Configure trusted publisher on TestPyPI: https://test.pypi.org/manage/account/publishing/
-# 3. See docs/deployment/pypi-setup.md for detailed setup instructions
+# 1. Configure trusted publisher on TestPyPI: https://test.pypi.org/manage/account/publishing/
+# 2. See docs/deployment/pypi-setup.md for detailed setup instructions
 
 env:
   # Comment trigger words for package publishing
@@ -26,14 +28,11 @@ on:
     branches: [main]
   workflow_dispatch:
     inputs:
-      environment:
-        description: 'Environment to publish to'
-        required: true
-        default: 'testpypi'
-        type: choice
-        options:
-        - testpypi
-        - pypi
+      force:
+        description: 'Force publish even if version exists'
+        required: false
+        default: false
+        type: boolean
 
 concurrency:
   group: "pypi-publishing"
@@ -47,7 +46,7 @@ jobs:
     outputs:
       default-python-version: ${{ steps.config.outputs.default-python-version }}
       package-version: ${{ steps.config.outputs.package-version }}
-      is-release: ${{ steps.config.outputs.is-release }}
+      pypi-name: ${{ steps.config.outputs.pypi-name }}
     steps:
     - name: Checkout code
       uses: actions/checkout@v6.0.1
@@ -61,8 +60,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: [get-config]
     environment:
-      name: ${{ needs.get-config.outputs.is-release == 'true' && 'pypi' || github.event.inputs.environment || 'testpypi' }}
-      url: ${{ needs.get-config.outputs.is-release == 'true' && 'https://pypi.org/p/open-resource-broker' || 'https://test.pypi.org/p/open-resource-broker' }}
+      name: testpypi
+      url: https://test.pypi.org/p/${{ needs.get-config.outputs.pypi-name }}
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
       contents: read   # needed to checkout code
@@ -75,20 +74,11 @@ jobs:
 
     - name: Determine version and target
       run: |
-        if [[ "${{ needs.get-config.outputs.is-release }}" == "true" ]]; then
-          {
-            echo "VERSION=${{ needs.get-config.outputs.package-version }}"
-            echo "TARGET=pypi"
-            echo "IS_RELEASE=true"
-          } >> "$GITHUB_ENV"
-        else
-          # Dev version for TestPyPI - use centralized version
-          {
-            echo "VERSION=${{ needs.get-config.outputs.package-version }}"
-            echo "TARGET=testpypi"
-          } >> "$GITHUB_ENV"
-        fi
-        echo "Publishing to: $TARGET with version: $VERSION"
+        {
+          echo "VERSION=${{ needs.get-config.outputs.package-version }}"
+          echo "TARGET=testpypi"
+        } >> "$GITHUB_ENV"
+        echo "Publishing to: TestPyPI with version: $VERSION"
 
     - name: Setup Python and UV
       uses: ./.github/actions/setup-uv-cached
@@ -110,37 +100,23 @@ jobs:
         verbose: true
         skip-existing: true
 
-    - name: Publish to PyPI
-      if: github.event_name == 'release'
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        verbose: true
-        skip-existing: true
-
     - name: Create deployment summary
       run: |
         {
           echo "## Package Published Successfully"
           echo ""
-          if [ "$TARGET" = "pypi" ]; then
-            echo "**Environment:** Production PyPI"
-            echo "**Installation:** \`pip install open-resource-broker\`"
-          else
-            echo "**Environment:** Test PyPI"
-            echo "**Installation:** \`pip install --index-url https://test.pypi.org/simple/ open-resource-broker\`"
-          fi
+          echo "**Environment:** Test PyPI"
+          echo "**Installation:** \`pip install --index-url https://test.pypi.org/simple/ ${{ needs.get-config.outputs.pypi-name }}\`"
           echo ""
           echo "**Version:** $VERSION"
           echo "**Commands:**"
           echo "- \`orb --help\`"
-          echo "- \`open-resource-broker --help\`"
         } >> "$GITHUB_STEP_SUMMARY"
 
   generate-sbom:
     name: Generate SBOM
     runs-on: ubuntu-latest
     needs: [get-config, publish]
-    if: github.event_name == 'release' || github.event.inputs.environment == 'pypi'
 
     permissions:
       contents: read

.github/workflows/prod-release.yml

@@ -31,6 +31,7 @@ jobs:
       container-image: ${{ steps.config.outputs.container-image }}
       package-version: ${{ steps.config.outputs.package-version }}
       is-release: ${{ steps.config.outputs.is-release }}
+      pypi-name: ${{ steps.config.outputs.pypi-name }}
     steps:
     - name: Checkout code
       uses: actions/checkout@v6.0.1

.github/workflows/security-code.yml

@@ -112,7 +112,7 @@ jobs:
       uses: actions/dependency-review-action@v4
       with:
         fail-on-severity: moderate
-        allow-licenses: MIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, ISC
+        allow-licenses: MIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, ISC, Unlicense
 
   codeql-analysis:
     name: CodeQL Analysis

.project.yml

@@ -4,6 +4,7 @@
 
 project:
   name: open-resource-broker
+  pypi_name: orb-py # PyPI distribution name
   short_name: orb # CLI command name
   version: 1.0.0
   description: "Cloud provider integration plugin for IBM Spectrum Symphony Host Factory"

README.md

@@ -4,7 +4,7 @@
 [![Quality Checks](https://github.com/awslabs/open-resource-broker/workflows/Quality%20Checks/badge.svg)](https://github.com/awslabs/open-resource-broker/actions/workflows/ci-quality.yml)
 [![Security Scanning](https://github.com/awslabs/open-resource-broker/workflows/Security%20Scanning/badge.svg)](https://github.com/awslabs/open-resource-broker/actions/workflows/security-code.yml)
 [![Latest Release](https://img.shields.io/github/v/release/awslabs/open-resource-broker)](https://github.com/awslabs/open-resource-broker/releases)
-[![PyPI Version](https://img.shields.io/pypi/v/open-resource-broker)](https://pypi.org/project/open-resource-broker/)
+[![PyPI Version](https://img.shields.io/pypi/v/orb-py)](https://pypi.org/project/orb-py/)
 [![License](https://img.shields.io/github/license/awslabs/open-resource-broker)](LICENSE)
 
 A cloud provider integration plugin for IBM Spectrum Symphony Host Factory, enabling dynamic provisioning of compute resources with a REST API interface and structured architecture implementation.
@@ -65,7 +65,7 @@ curl http://localhost:8000/health
 
 ```bash
 # Install from PyPI
-pip install open-resource-broker
+pip install orb-py
 
 # Verify installation
 orb --version
@@ -104,7 +104,7 @@ make dev
 
 | Method | Location | Use Case | Command |
 |--------|----------|----------|---------|
-| **PyPI** | System Python | End users | `pip install open-resource-broker` |
+| **PyPI** | System Python | End users | `pip install orb-py` |
 | **System** | `/usr/local/orb/` or `~/.local/orb/` | Production deployment | `make install-system` |
 | **Local** | `./.venv/` | Development | `make dev-install` |
 
@@ -410,7 +410,7 @@ make test-performance
 
 ### Project Health & Metrics
 
-[![Python Versions](https://img.shields.io/pypi/pyversions/open-resource-broker)](https://pypi.org/project/open-resource-broker/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/orb-py)](https://pypi.org/project/orb-py/)
 [![Success Rate](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/fgogolli/ec3393a523fa3a6b6ff89a0636de3085/raw/success-rate.json)](https://github.com/awslabs/open-resource-broker/actions/workflows/health-monitoring.yml)
 [![Avg Duration](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/fgogolli/ec3393a523fa3a6b6ff89a0636de3085/raw/avg-duration.json)](https://github.com/awslabs/open-resource-broker/actions/workflows/health-monitoring.yml)
 [![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/fgogolli/50bc37df3c178a0846dbd3682a71d50a/raw/coverage.json)](https://github.com/awslabs/open-resource-broker/actions/workflows/advanced-metrics.yml)

dev-tools/scripts/generate_pyproject.py

@@ -79,6 +79,12 @@ def update_pyproject_selective(pyproject_path: Path) -> None:
     # Get metadata updates
     package_name = _get_config_value(".project.name")
     package_name_short = _get_config_value(".project.short_name")
+
+    # Get PyPI-specific name, fallback to package_name if not set
+    pypi_name = _get_config_value(".project.pypi_name")
+    if not pypi_name or pypi_name == "null":
+        pypi_name = package_name
+
     version = _get_config_value(".project.version")
     description = _get_config_value(".project.description")
     author = _get_config_value(".project.author")
@@ -114,7 +120,7 @@ def update_pyproject_selective(pyproject_path: Path) -> None:
             new_lines.extend(
                 [
                     "[project]",
-                    f'name = "{package_name}"',
+                    f'name = "{pypi_name}"',
                     f'version = "{version}"',
                     f'description = "{description}"',
                     'readme = "README.md"',

docs/root/deployment/pypi-setup.md

@@ -119,10 +119,10 @@ To verify trusted publishing is working:
 3. **Verify Package:**
    ```bash
    # Test installation from Test PyPI
-   pip install --index-url https://test.pypi.org/simple/ open-resource-broker
+   pip install --index-url https://test.pypi.org/simple/ orb-py
 
    # Test installation from Production PyPI
-   pip install open-resource-broker
+   pip install orb-py
    ```
 
 ## Security Best Practices

docs/root/deployment/readme.md

@@ -116,7 +116,7 @@ gcloud run deploy orb-api \
 #### Direct Installation
 ```bash
 # Install from PyPI
-pip install open-resource-broker
+pip install orb-py
 
 # Or install from source
 git clone <repository-url>

docs/root/deployment/traditional.md

@@ -21,7 +21,7 @@ source orb-env/bin/activate
 
 ```bash
 # Install from PyPI
-pip install open-resource-broker
+pip install orb-py
 
 # Or install from source
 git clone <repository-url>