images icon indicating copy to clipboard operation
images copied to clipboard

Does not work out of the box with python 3.12 due to missing setuptools package

Open t-b opened this issue 10 months ago • 11 comments

$ pip show sphinxcontrib-images
Name: sphinxcontrib-images
Version: 0.9.4
Summary: Sphinx extension for thumbnails
Home-page: https://github.com/sphinx-contrib/images
Author: Tomasz Czyż
Author-email: [email protected]
License: Apache 2
Location: C:\Users\Admin\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\site-packages
Requires: requests, sphinx
Required-by:

I needed to install the setuptools package as otherwise I got a message like

Could not import extension sphinxcontrib.images (exception: No module named 'pkg_resources')

t-b avatar Jan 21 '25 20:01 t-b

@t-b Good to know, thank you. Maybe it has to do with distutils being removed from Python 3.12 https://peps.python.org/pep-0632/ and setuptools package providing an implementation of pkg_resources https://setuptools.pypa.io/en/latest/pkg_resources.html .

I suppose it will be fixed if/when the package is brought up to date.

jonascj avatar Mar 31 '25 21:03 jonascj

@t-b https://test.pypi.org/project/sphinxcontrib-images/0.9.5rc1/ is a first shot at a new release compatible with python 3.10+ and sphinx > 5.

If you try it out I'd be happy to know if it resolves this issue. It should.

jonascj avatar Apr 04 '25 10:04 jonascj

@jonascj Where does the code for 0.9.5rc1 live? I can't find it in this repo.

t-b avatar Apr 08 '25 19:04 t-b

@t-b Sorry for the bad form - that test.pypi.org relase is based on the pr3941 branch (https://github.com/sphinx-contrib/images/tree/pr3941). It was just meant as a quick test of whether everything would work (CI, building, releasing, installing) if #39 and #41 were merged. So the branch wasn't well named or tagged, and the branch pr3941 contains nothing apart from #39 and #41 to support the release (not correct version number, not updated documentation etc.).

jonascj avatar Apr 08 '25 20:04 jonascj

@jonascj I've installed and used it successfully on Python 3.13 with the latest Sphinx release (the last official sphinxcontrib-images release was not working).

Thanks for your work !

aurelien35 avatar Apr 09 '25 04:04 aurelien35

@aurelien35 Thank you for performing an in vivo test of the 0.9.5rc1 build!

jonascj avatar Apr 09 '25 06:04 jonascj

I've also used this version, and while it has a logging bug that's already been acknowledged in the PR, it actually still works, just with a bunch of scary tracebacks getting printed. I'd love to see v0.9.5 get a release ASAP.

coredumperror avatar Apr 10 '25 18:04 coredumperror

@coredumperror Is "logging bug" referring to the discussion of brown vs. 'brown' in #41 ? I don't think I see this issue, but I'd like to see your logs / console session.

jonascj avatar Apr 10 '25 20:04 jonascj

I'm having the same problem weeks ago, but the 0.9.5rc1 build works, a work around before a fixed arrives.

TriangleBear avatar Apr 11 '25 07:04 TriangleBear

@jonascj would you consider publishing the rc-release on the "real" pypi repo?

The test-repo is not exposed via our company internal pypi proxy (and won't be). Only the true repo is available to us.

Considering that the release is flagged as a "release-candidate" it won't be pulled in by any automated installs unless users explicitly opt-in. I don't see a risk publishing it for real. In the end, that's what PEP-440 pre-releases are for. That way I could also test it in our environment.

exhuma avatar May 14 '25 08:05 exhuma

Same here, as of now the answer is if they are going to work with it and release this by this month. No harm on going for the 0.9.5rc2 to be targeted as released because as of writing this I've been working with that rc-release since 1 1/2 months now and no signs of bugs.

Are we waiting for a release date?

TriangleBear avatar May 14 '25 13:05 TriangleBear

@exhuma Thank you for pushing / asking for the obvious next step. Sorry it took so long to do - I got hung up on unimportant details like new issues, the documentation etc. and work.

The up-to-date version is now released as 1.0.0:

https://pypi.org/project/sphinxcontrib-images/1.0.0/

Again thank you to everyone who pushed for a new release and the merges etc. needed to get there! Remember I'm still looking for a co-maintainer #48 :-)

jonascj avatar Jun 07 '25 18:06 jonascj