Python Build for Conda Users

[ElliotHYLee]

Since I use Python with Conda, I wanted to share a bash script to build wheel and install to sitepackage. As I don't have much time to test and format for PR, let me casually share the Python builder here for anyone who may need it.

0. Build the project.

For my case, I built with c++ with iceoryx 1 camke install. (maybe not much related..)

1. Create the bash script

bulid_python_wheel_install.bash

under iceoryx2-ffi/python

2. Assuming new conda env is on,

bash bulid_python_wheel_install.bash --wheel # wheel-only creation

or

bash bulid_python_wheel_install.bash --install-wheel #create wheel and install

---

the bash script

#!/bin/bash
set -e

BUILD_WHEEL=false
INSTALL_WHEEL=false

# Parse command line arguments
while [[ $# -gt 0 ]]; do
    case $1 in
        --wheel)
            BUILD_WHEEL=true
            shift
            ;;
        --install-wheel)
            BUILD_WHEEL=true
            INSTALL_WHEEL=true
            shift
            ;;
        --help)
            echo "Usage: $0 [OPTIONS]"
            echo "Options:"
            echo "  --wheel         Build wheel instead of development install"
            echo "  --install-wheel Build wheel and install it"
            echo "  --help          Show this help message"
            exit 0
            ;;
        *)
            echo "Unknown option: $1"
            exit 1
            ;;
    esac
done

echo "Installing Python development tools..."
pip install maturin pytest black isort bandit prospector[with_mypy]

echo "Current directory: $(pwd)"
echo "Contents: $(ls -la)"

# Find the correct Cargo.toml path
if [ -f "Cargo.toml" ]; then
    CARGO_MANIFEST="Cargo.toml"
    TARGET_DIR="../../target/ff/python"
    echo "Found Cargo.toml in current directory"
elif [ -f "../Cargo.toml" ]; then
    CARGO_MANIFEST="../Cargo.toml"
    TARGET_DIR="../../../target/ff/python"
    echo "Found Cargo.toml in parent directory"
else
    echo "Error: Cannot find Cargo.toml file"
    echo "Please run this script from the iceoryx2-ffi/python directory"
    exit 1
fi

if [ "$BUILD_WHEEL" = true ]; then
    echo "Building iceoryx2 Python wheel with maturin..."
    echo "Using manifest: $CARGO_MANIFEST"
    echo "Using target dir: $TARGET_DIR"
    
    # Build wheel (optimized release build)
    maturin build --release --manifest-path "$CARGO_MANIFEST" --target-dir "$TARGET_DIR"
    
    # Find the built wheel
    WHEEL_FILE=$(find target/wheels -name "*.whl" 2>/dev/null | head -1)
    if [ -z "$WHEEL_FILE" ]; then
        WHEEL_FILE=$(find ../../target/wheels -name "*.whl" 2>/dev/null | head -1)
    fi
    
    if [ -n "$WHEEL_FILE" ]; then
        echo "✓ Wheel built successfully: $WHEEL_FILE"
        
        if [ "$INSTALL_WHEEL" = true ]; then
            echo "Installing wheel..."
            pip install "$WHEEL_FILE" --force-reinstall
        else
            echo "To install this wheel later, run:"
            echo "  pip install $WHEEL_FILE"
        fi
    else
        echo "Error: Could not find built wheel file"
        exit 1
    fi
else
    echo "Building iceoryx2 Python extension with maturin (development mode)..."
    echo "Using manifest: $CARGO_MANIFEST"
    echo "Using target dir: $TARGET_DIR"
    
    # Compile PyO3 bindings and install directly into current conda environment
    maturin develop --manifest-path "$CARGO_MANIFEST" --target-dir "$TARGET_DIR"
fi

echo "Verifying installation..."
python -c "import iceoryx2; print('✓ iceoryx2 module imported successfully')"

echo "Running tests..."
pytest tests/

echo "Running code quality checks..."

# Check linting for main Python source
echo "Checking python-src/iceoryx2..."
prospector -m -D -T -s veryhigh -F --profile ../../.prospector-iceoryx2.yaml python-src/iceoryx2

# Check linting for tests
echo "Checking tests..."
prospector -m -D -T -s veryhigh -F --profile ../../.prospector-tests.yaml tests

# Check examples (only if they exist)
if [ -d "../../examples/python" ]; then
    echo "Checking examples..."
    for dir in ../../examples/python/*/; do 
        echo "Linting $dir"
        prospector -m -D -T -s veryhigh -F --profile ../../.prospector.yaml "$dir" || exit 1
    done
fi

echo "Checking imports..."
isort --check-only python-src/iceoryx2
isort --check-only tests
if [ -d "../../examples/python" ]; then
    isort --check-only ../../examples/python
fi

echo "Checking formatting..."
black --check python-src/iceoryx2
black --check tests
if [ -d "../../examples/python" ]; then
    black --check ../../examples/python
fi

echo "✓ All checks completed successfully!"

if [ "$BUILD_WHEEL" = true ] && [ -n "$WHEEL_FILE" ]; then
    echo ""
    echo "Wheel created: $WHEEL_FILE"
    echo "You can now:"
    echo "  1. Copy this wheel to other machines"
    echo "  2. Install it with: pip install $WHEEL_FILE"
    echo "  3. Upload to PyPI with: twine upload $WHEEL_FILE"
fi

echo ""
echo "To fix formatting and imports automatically, run:"
echo "  black python-src/iceoryx2 tests"
echo "  isort python-src/iceoryx2 tests"
if [ -d "../../examples/python" ]; then
    echo "  black ../../examples/python"
    echo "  isort ../../examples/python"
fi

[elfenpiff]

@ElliotHYLee thanks for sharing!