Skip to content

Improve Python bindings and Windows&Apple Silicon support #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
May 5, 2025

Conversation

ThePituLegend
Copy link
Collaborator

@ThePituLegend ThePituLegend commented Apr 30, 2025

This PR originally aims to improve the initially proposed Python bindings. They were functional but not easy for the final user to use. Thus, we streamlined the Python experience as much as possible, as this feature has been deemed useful for the community. There are still some rough edges, but it is far better.

To that end, we worked on the following features:

  • Python module is now compilable and installable from source code with a simple pip install .
  • We provide precompiled Wheels and SDist, which are hosted at PyPI. Thus, end users can install QuickEd for Python with a simple pip install quicked.
    If there is sufficient interest, we will consider working on preparing Conda-forge/Bioconda packages.

To handle this new setup (mainly for precompiled Wheels), we implemented a dynamic dispatcher in the Python module that chooses between the SIMD or scalar compilations depending on host availability.
This process indirectly forced us to add better support for Windows and Apple Silicon machines, as we should support many configurations for the Python package to work on as many machines as possible.
Now, the CMake default config considers the following targets (OS/Arch/Compiler combo):

  • Linux (Ubuntu) x86_64, GCC & Clang
  • MacOS x86_64, GCC & Clang
  • (NEW) MacOS ARM (Apple Silicon), GCC & Clang
  • (NEW) Windows x86_64, GCC, Clang & MSVC compiler

Unofficially, Android ARM also works, although there is no precompiled package for this target.

As more platforms are now supported, we updated the release Action to upload precompiled binaries for all supported platforms automatically. We also added a release Action to build and upload the Python package to PyPI automatically.

@ThePituLegend ThePituLegend requested a review from maxdoblas April 30, 2025 13:29
@ThePituLegend ThePituLegend force-pushed the python branch 2 times, most recently from 1906615 to e16f09b Compare April 30, 2025 13:49
Build and upload the release binaries for all supported platforms.
Also, build and upload Python wheels to PyPI.
@ThePituLegend ThePituLegend marked this pull request as ready for review May 5, 2025 12:08
@maxdoblas maxdoblas merged commit 2b1d44b into maxdoblas:main May 5, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants