Move wheel building to prep-relase script (#120)

* move building of wheels to prep release script

* Add egg info to gitignore

* Change variable name of version inside build_wheels

* Change verison to python version to not confuse sed command

* update variable name

* Remove build stuff from script and add SDK_VERSION to setup.py

* Remove build from template and add comment to template

Author: MOmarMiraj

.gitignore

@@ -2,7 +2,7 @@
 .idea
 *__pycache__
 dist/
-onepassword.egg-info/
 .DS_Store
 build/
-.python-version
+.python-version
+onepassword_sdk.egg-info/

Makefile

@@ -1,10 +1,10 @@
 PYTHON_VERSIONS := 3.9 3.10 3.11 3.12
 
 release:
-	src/release/scripts/release.sh $(PYTHON_VERSIONS)
+	src/release/scripts/release.sh
 
 prep-release:
-	src/release/scripts/prep-release.sh
+	src/release/scripts/prep-release.sh $(PYTHON_VERSIONS)
 
 release/install-dependencies:
 # Install pyenv

setup.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from setuptools import setup, find_packages
 from sysconfig import get_platform
+from version import SDK_VERSION
 import platform
 import os
 
@@ -46,7 +47,7 @@ def get_shared_library_data_to_include():
 
 setup(
     name="onepassword-sdk",
-    version="0.1.1",
+    version=SDK_VERSION,
     author="1Password",
     long_description= (Path(__file__).parent / "README.md").read_text(),
     long_description_content_type='text/markdown',

src/release/scripts/prep-release.sh

@@ -2,18 +2,27 @@
 
 # Helper script to prepare a release for the Python SDK.
 
-output_version_file="src/release/version.py"
+output_version_file="version.py"
 version_template_file="src/release/templates/version.tpl.py"
 
+# The list of python verisons the SDKs release for
+python_versions=("$@")
+
+# Minimum glibc version we support
+glibc_version=2-32
+
+# These versions are being supported due to the SDKs supporting Python 3.9+
+macOS_version_x86_64=10.9
+macOS_version_arm64=11.0
+
 # Extracts the current build/version number for comparison and backup 
-current_build=$(awk -F "['\"]" '/SDK_BUILD_NUMBER =/{print $2}' "$output_version_file")
 current_version=$(awk -F "['\"]" '/SDK_VERSION =/{print $2}' "$output_version_file")
 
 # Function to execute upon exit
 cleanup() {
     echo "Performing cleanup tasks..."
     # Revert changes to file if any
-    sed -e "s/{{ build }}/$current_build/" -e "s/{{ version }}/$current_version/" "$version_template_file" > "$output_version_file"
+    sed -e "s/{{ version }}/$current_version/" "$version_template_file" > "$output_version_file"
     exit 1   
 }
 
@@ -50,27 +59,38 @@ update_and_validate_version() {
     done
 }
 
-# Function to validate the build number format.
-# SEMVER Format: Mmmppbb - 7 Digits 
-update_and_validate_build() {
-    while true; do
-        # Prompt the user to input the build number
-        read -p "Enter the build number (format: Mmmppbb): " build
-
-        # Validate the build number format
-        if [[ "${build}" =~ ^[0-9]{7}$ ]]; then
-            if (( 10#$current_build < 10#$build )); then
-                # Write the valid build number to the file
-                echo "New build number is: ${build}"
-                return 0
+build_wheels() {
+    os_platform=$1
+    machine_platform=$2
+
+    export PYTHON_OS_PLATFORM=$os_platform
+    export PYTHON_MACHINE_PLATFORM=$machine_platform
+
+    case "$os_platform" in 
+        Darwin)
+            macos_version=
+            if [[ "$machine_platform" == "x86_64" ]]; then
+                macos_version=$macOS_version_x86_64
             else
-                echo "New build version should be higher than current build version."
+                macos_version=$macOS_version_arm64
             fi
-        else
-            echo "Invalid build number format: ${build}"
-            echo "Please enter a build number in the 'Mmmppbb' format."
-        fi
-    done
+
+            export _PYTHON_HOST_PLATFORM="macosx-${macos_version}-${PYTHON_MACHINE_PLATFORM}"
+            ;;
+        Linux)
+            export _PYTHON_HOST_PLATFORM="manylinux-${glibc_version}-${PYTHON_MACHINE_PLATFORM}"
+            ;;
+        Windows)
+            export _PYTHON_HOST_PLATFORM="win-${PYTHON_MACHINE_PLATFORM}"
+            ;;
+        *)
+            echo "Unsupported OS: $os_platform"
+            exit 1
+            ;;
+    esac
+
+    pyenv exec python setup.py bdist_wheel
+    rm -rf build
 }
 
 # Ensure working directory is clean
@@ -79,11 +99,21 @@ enforce_latest_code
 # Update and validate the version number
 update_and_validate_version
 
-# Update and validate the build number
-update_and_validate_build 
-
-# Update version & build number in version.py
-sed -e "s/{{ build }}/$build/" -e "s/{{ version }}/$version/" "$version_template_file" > "$output_version_file"
+# Update version in version.py
+sed  -e "s/{{ version }}/$version/" "$version_template_file" > "$output_version_file"
+
+# Acquire the wheels for different OS
+for python_version in "${python_versions[@]}"; do
+pyenv local $python_version
+build_wheels Darwin x86_64
+build_wheels Darwin arm64
+build_wheels Linux x86_64
+build_wheels Linux aarch64
+build_wheels Windows amd64
+done
+
+# Build Source as well incase wheels fails, pypi can install this as backup (standard practice)
+python3 -m build --sdist
 
 printf "Press ENTER to edit the RELEASE-NOTES in your default editor...\n"
 read -r _ignore

src/release/scripts/release.sh

@@ -4,53 +4,8 @@
 
 set -e
 
-# The list of python verisons the SDKs release for
-python_versions=("$@")
-
-# Minimum glibc version we support
-glibc_version=2-32
-
-# These versions are being supported due to the SDKs supporting Python 3.9+
-macOS_version_x86_64=10.9
-macOS_version_arm64=11.0
-
-build_wheels() {
-    os_platform=$1
-    machine_platform=$2
-
-    export PYTHON_OS_PLATFORM=$os_platform
-    export PYTHON_MACHINE_PLATFORM=$machine_platform
-
-    case "$os_platform" in 
-        Darwin)
-            version=
-            if [[ "$machine_platform" == "x86_64" ]]; then
-                version=$macOS_version_x86_64
-            else
-                version=$macOS_version_arm64
-            fi
-
-            export _PYTHON_HOST_PLATFORM="macosx-${version}-${PYTHON_MACHINE_PLATFORM}"
-            ;;
-        Linux)
-            export _PYTHON_HOST_PLATFORM="manylinux-${glibc_version}-${PYTHON_MACHINE_PLATFORM}"
-            ;;
-        Windows)
-            export _PYTHON_HOST_PLATFORM="win-${PYTHON_MACHINE_PLATFORM}"
-            ;;
-        *)
-            echo "Unsupported OS: $os_platform"
-            exit 1
-            ;;
-    esac
-
-    pyenv exec python setup.py bdist_wheel
-    rm -rf build
-}
-
 # Read the contents of the files into variables
-version=$(awk -F "['\"]" '/SDK_VERSION =/{print $2}' "src/release/version.py")
-build=$(awk -F "['\"]" '/SDK_BUILD_NUMBER =/{print $2}' "src/release/version.py")
+version=$(awk -F "['\"]" '/SDK_VERSION =/{print $2}' "version.py")
 release_notes=$(< src/release/RELEASE-NOTES)
 
 # Check if Github CLI is installed
@@ -72,20 +27,6 @@ git push origin tag "v${version}"
 
 gh release create "v${version}" --title "Release ${version}" --notes "${release_notes}" --repo github.com/1Password/onepassword-sdk-python
 
-
-# Acquire the wheels for different OS
-for version in "${python_versions[@]}"; do
-pyenv local $version
-build_wheels Darwin x86_64
-build_wheels Darwin arm64
-build_wheels Linux x86_64
-build_wheels Linux aarch64
-build_wheels Windows amd64
-done
-
-# Build Source as well incase wheels fails, pypi can install this as backup (standard practice)
-python3 -m build --sdist
-
 # Release on PyPi
 python3 -m twine upload dist/*
 

src/release/templates/version.tpl.py

@@ -1,2 +1,2 @@
-SDK_VERSION = "{{ version }}"
-SDK_BUILD_NUMBER = "{{ build }}"
+# TODO: Refactor so SDK_BUILD_NUMBER can be inside and not hardcoded in defaults.py
+SDK_VERSION = "{{ version }}"

src/release/version.py

@@ -0,0 +1,2 @@
+# TODO: Refactor so SDK_BUILD_NUMBER can be inside and not hardcoded in defaults.py
+SDK_VERSION = "0.1.1"