Publish the 1Password SDK for Python on PyPI (#114)

* Add pypy support. This commit pushes to testPyPi

* Uncomment commented code

* Update metadata and readme for PyPi and make code more modular

* Fix setup.py and refactor script more

* Add source package and wheel packaging of macos 10.9 and 11.0

* Change variable name and reduce scope of version to just Darwin case

* Add new command to setup.py and refactor script

* add new line at EOF

* Revert from sdk_version to verson

* remove --verbose flag

* Add min pydantic version

* Use pyenv to upload wheels for each Python Version and update release readme with new instructions

* Remove support of Python 3.8 and update makefile to install required dependencies for pyenv

* Add installation of pyenv to the make target and update readme

* update setup.py to include more metadata

* Add installing build to dependencies

* add break system packages flag

Author: MOmarMiraj

.gitignore

@@ -4,4 +4,5 @@
 dist/
 onepassword.egg-info/
 .DS_Store
-build/
+build/
+.python-version

Makefile

@@ -1,7 +1,23 @@
+PYTHON_VERSIONS := 3.9 3.10 3.11 3.12
+
 release:
-	src/release/scripts/release.sh
+	src/release/scripts/release.sh $(PYTHON_VERSIONS)
 
 prep-release:
 	src/release/scripts/prep-release.sh
 
+release/install-dependencies:
+# Install pyenv
+	brew install pyenv
+
+# Install build
+	pip install build --break-system-packages
+	
+# Install all the python versions we support in one line
+	pyenv install --skip-existing $(PYTHON_VERSIONS)
 
+# Set pyenv local and install dependencies for each version
+	for version in $(PYTHON_VERSIONS); do \
+		pyenv local $$version; \
+		pyenv exec pip install wheel setuptools; \
+	done

setup.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from setuptools import setup, find_packages
 from sysconfig import get_platform
 import platform
@@ -13,14 +14,15 @@ def finalize_options(self):
             # This platform naming is sufficient for distributing this package via source cloning (e.g. pip + GitHub) since the wheel will be built locally
             # for each user's platform: https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#basic-platform-tags
             self.plat_name = get_platform().translate({"-": "_", ".": "_"})
+            self.plat_name_supplied = True
 except ImportError:
     bdist_wheel = None
 
 
 def get_shared_library_data_to_include():
     # Return the correct uniffi C shared library extension for the given platform
     include_path = "lib"
-    machine_type = platform.machine().lower()
+    machine_type = os.getenv("PYTHON_MACHINE_PLATFORM") or platform.machine().lower() 
     if machine_type in ["x86_64", "amd64"]:
         include_path = os.path.join(include_path, "x86_64")
     elif machine_type in ["aarch64", "arm64"]:
@@ -32,7 +34,8 @@ def get_shared_library_data_to_include():
         "Linux": "libop_uniffi_core.so",
         "Windows": "op_uniffi_core.dll",
     }
-    c_shared_library_file_name = platform_to_lib.get(platform.system(), "")
+    platform_name = os.getenv("PYTHON_OS_PLATFORM") or platform.system()
+    c_shared_library_file_name = platform_to_lib.get(platform_name, "")
     c_shared_library_file_name = os.path.join(include_path, c_shared_library_file_name)
 
     uniffi_bindings_file_name = "op_uniffi_core.py"
@@ -42,18 +45,34 @@ def get_shared_library_data_to_include():
 
 
 setup(
-    name="onepassword",
+    name="onepassword-sdk",
     version="0.1.1",
     author="1Password",
+    long_description= (Path(__file__).parent / "README.md").read_text(),
+    long_description_content_type='text/markdown',
     description="The 1Password Python SDK offers programmatic read access to your secrets in 1Password in an interface native to Python.",
     url="https://github.com/1Password/onepassword-sdk-python",
     packages=find_packages(
         where="src",
     ),
+    license="MIT",
+    license_files="LICENSE",
     package_dir={"": "src"},
+    python_requires=">=3.9",
+    classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License"
+    ],
     cmdclass={"bdist_wheel": bdist_wheel},
     package_data={"": get_shared_library_data_to_include()},
     install_requires=[
-        "pydantic",
+        "pydantic>=2.5", # Minimum Pydantic version to run the Python SDK
     ],
 )

src/release/README.md

@@ -2,6 +2,11 @@
 
 Before running this script, the user must make sure that they have the write permissions to the Python SDK repository.
 
+Run this make command to install all dependencies required for the Python SDK release process.
+```
+release/install-dependencies
+```
+
 Step 1. Make any changes to the SDK as required on a feature branch or main branch.
 NOTE: If ran on a main branch, a release branch will be created.
 
@@ -15,8 +20,10 @@ Step 3. Ensure that the correct files have been updated - i.e. version/build fil
 
 Step 4. Ensure your GITHUB_TOKEN environment variable is set as this will allow you to create the tags/release and push it.
 
-Step 5. If everything looks good, at the root of the repo, run:
+Step 6. Ensure you have the PyPi credentials to login when uploading the source and wheels to PyPi.
+
+Step 7. If everything looks good, at the root of the repo, run:
 ```
 make release
 ```
-Step 6. Congratulations, you have released the newest Python SDK!
+Step 8. Congratulations, you have released the newest Python SDK!

src/release/scripts/release.sh

@@ -4,12 +4,55 @@
 
 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")
 release_notes=$(< src/release/RELEASE-NOTES)
 
-
 # Check if Github CLI is installed
 if ! command -v gh &> /dev/null; then
 	echo "gh is not installed";\
@@ -29,3 +72,23 @@ 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/*
+
+# Delete the dist folder after published
+rm -r dist src/*.egg-info
+