openslide / openslide-python

Python bindings to OpenSlide
https://openslide.org/
GNU Lesser General Public License v2.1
374 stars 183 forks source link

Support openslide-bin #267

Closed bgilbert closed 2 months ago

bgilbert commented 7 months ago

Prefer loading OpenSlide from the openslide-bin package if available.

For ease of use, document openslide-bin as the preferred installation option. Don't document manual installation of openslide-bin binaries on Linux and macOS, since there isn't generally an advantage to doing that, but leave the existing Windows Zip instructions for compatibility and to explain os.add_dll_directory().

Add an explanatory ModuleNotFoundError on Linux if OpenSlide is not found.

openslide-bot commented 7 months ago

DCO signed off :heavy_check_mark:

All commits have been signed off. You have certified to the terms of the Developer Certificate of Origin, version 1.1. In particular, you certify that this contribution has not been developed using information obtained under a non-disclosure agreement or other license terms that forbid you from contributing it under the GNU Lesser General Public License, version 2.1.

Mr-Milk commented 5 months ago

May I ask when this PR will be merged and the potential release date of openslide-python 1.4.0?

bgilbert commented 5 months ago

Hopefully within the next couple months. The missing pieces for this PR are docs and error message updates, which don't affect the functionality, so while you're waiting you should be able to use a local OpenSlide Python build with this patch applied.

Mr-Milk commented 5 months ago

I can help with the docs and the error message part if this can accelerate the release process.

bgilbert commented 5 months ago

Thanks for the offer. 1.4.0 isn't only waiting for this PR, though. Type hints and some additional cleanups are also planned, and my attention is currently on some work in the main OpenSlide repo.

If you'd like to contribute the docs and error updates, feel free to submit a new PR to this repo with just those changes. If they look good, I can merge them into this branch or land them separately.