Merge pull request #26 from qsharp-community/bugfix/pythonn-packaging

improve Python packaging

Author: filipw

.github/workflows/ci.yml

@@ -33,6 +33,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip setuptools wheel
           python setup.py sdist bdist_wheel
+        env:
+          PACKAGE_VERSION: 0.99.0
 
       - name: Upload Python Package Artifact
         uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -18,41 +18,75 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        
+      - name: Set version from tag
+        id: get_version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+          else
+            echo "VERSION=${{ github.event.inputs.tag_name }}" >> $GITHUB_ENV
+          fi
+        shell: bash
+        
+      - name: Show version
+        run: echo "Building version ${{ env.VERSION }}"
+        shell: bash
+        
       - name: Install uniffi-bindgen-cs
         run: |
           cargo install uniffi-bindgen-cs --git https://github.com/NordSecurity/uniffi-bindgen-cs --tag v0.2.0
+          
       - name: Build Rust Library
         run: |
           cargo build --release --manifest-path ${{ github.workspace }}/Cargo.toml
+          
       - name: Build Python Package
         working-directory: platforms/python/qsharp-bridge
         run: |
           python -m pip install --upgrade pip setuptools wheel
           python setup.py sdist bdist_wheel
+        env:
+          PACKAGE_VERSION: ${{ env.VERSION }}
+          
       - name: Upload wheels to release
         uses: softprops/action-gh-release@v1
         with:
           files: platforms/python/qsharp-bridge/dist/*.whl
-
+          
   build-swift-package:
     runs-on: macos-15
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        
+      - name: Set version from tag
+        id: get_version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+          else
+            echo "VERSION=${{ github.event.inputs.tag_name }}" >> $GITHUB_ENV
+          fi
+        
       - name: Install Rust targets
         run: |
           rustup target add aarch64-apple-ios
           rustup target add aarch64-apple-ios-sim
           rustup target add aarch64-apple-darwin
+          
       - name: Build Swift Package
         run: ./build_swift.sh
+        
       - name: Clean temporary build files from Swift Package
         run: rm -rf platforms/swift/Qsharp.Bridge/.build
+        
       - name: Create zip archive of Swift Package
         run: |
           cd platforms/swift
           zip -r Qsharp.Bridge-SwiftPackage.zip Qsharp.Bridge
+          
       - name: Upload Swift Package to release
         uses: softprops/action-gh-release@v1
         with:
-          files: platforms/swift/Qsharp.Bridge-SwiftPackage.zip
+          files: platforms/swift/Qsharp.Bridge-SwiftPackage.zip

platforms/python/qsharp-bridge/setup.py

@@ -5,7 +5,6 @@
 from setuptools import setup, find_packages
 from setuptools.command.build_py import build_py as _build_py
 
-# Import the bdist_wheel command from wheel
 try:
     from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
 except ImportError:
@@ -15,6 +14,7 @@
 CARGO_MANIFEST_PATH = os.path.abspath(os.path.join(HERE, "../../../Cargo.toml"))
 CARGO_TARGET_DIR = os.path.abspath(os.path.join(HERE, "../../../target/release"))
 BINDINGS_SRC = os.path.abspath(os.path.join(HERE, "../../../bindings/qsharp_bridge.py"))
+VERSION = os.environ.get("PACKAGE_VERSION", "0.1.0")
 
 def get_lib_filename():
     """
@@ -47,39 +47,56 @@ def run(self):
             "cargo", "build", "--release",
             "--manifest-path", CARGO_MANIFEST_PATH
         ])
-
         # 2. copy the native library from Cargo's output folder into the Python package.
         src_lib = os.path.join(CARGO_TARGET_DIR, lib_filename)
         dst_dir = os.path.join(HERE, "qsharp_bridge")
         dst_lib = os.path.join(dst_dir, lib_filename)
         self.mkpath(dst_dir)
         print(f"Copying native library: {src_lib} -> {dst_lib}")
         self.copy_file(src_lib, dst_lib)
-
         # 3. copy uniFFI bindings file from the bindings/ folder.
         dst_binding = os.path.join(dst_dir, "qsharp_bridge.py")
         if os.path.exists(BINDINGS_SRC):
             print(f"Copying binding file: {BINDINGS_SRC} -> {dst_binding}")
             self.copy_file(BINDINGS_SRC, dst_binding)
         else:
             print("Warning: Binding file not found at", BINDINGS_SRC)
-
         # 4. continue with the standard build process.
         super().run()
 
 if _bdist_wheel:
     class bdist_wheel(_bdist_wheel):
         def finalize_options(self):
+            self.plat_name_supplied = True
+            
+            # Set the platform tag based on the system
+            if sys.platform.startswith('linux'):
+                self.plat_name = "py3-none-linux_x86_64"
+            elif sys.platform.startswith('darwin'):
+                self.plat_name = "py3-none-macosx_11_0_universal2"
+            elif sys.platform.startswith('win'):
+                self.plat_name = "py3-none-win_amd64"
+            else:
+                # Fall back to default behavior for unknown platforms
+                self.plat_name_supplied = False
+                
             super().finalize_options()
-            # mark the wheel as not pure so that a platform tag is used
-            # I am not sure I know what I am doing, but this sounds right
+            # We still need to mark it as not pure Python
             self.root_is_pure = False
+            
+        def get_tag(self):
+            # Override the tag generation to use our custom platform tag
+            if self.plat_name_supplied:
+                # Use py3 instead of cpXY to support any Python 3.x version
+                return ('py3', 'none', self.plat_name.split('-')[-1])
+            # Fall back to default behavior
+            return super().get_tag()
 else:
     bdist_wheel = None
 
 setup(
     name="qsharp-bridge",
-    version="0.1.0",
+    version=VERSION,
     description="Cross platform library for accessing Q# features in a simple way",
     author="Filip w",
     author_email="[email protected]",
@@ -91,4 +108,4 @@ def finalize_options(self):
         "Programming Language :: Python :: 3",
     ],
     python_requires=">=3.6",
-)
+)