epubcheck plugin for Sigil

[DiapDealer]

I'm happy it's working for you now, but there is really no need to install Python. Sigil comes with its own bundled Python environment.

[B10Mediaworx]

Yes, I knew that, and I've always had the "use bundled python" checked, which was why I couldn't figure out what changed and why it was no longer working.

[DiapDealer]

I got the exact same error as you on my virtual Windows 10 machine when launching the EPubCheck plugin. It then began to work correctly with no changes made whatsoever. I suspect something else is going on that triggers the failure under the right conditions.

[phillipgessert]

Probably unrelated, but I started getting an error re: missing distutils when using this plugin on MacOS. I thought it was an issue with the Mac’s python version, so was surprised to see I already had the Sigil python bundle checked. When I unchecked it, the plugin worked again.

[Doitsu]

Originally Posted by phillipgessert

Probably unrelated, but I started getting an error re: missing distutils when using this plugin on MacOS. I thought it was an issue with the Mac’s python version, so was surprised to see I already had the Sigil python bundle checked. When I unchecked it, the plugin worked again.

An older plugin version used pkg_resources for parsing version numbers.
Please check pugin.py for the following import:

from pkg_resources import parse_version

If it's not commented out you're using an older plugin version.

[KevinH]

And fwiw, according to Google:

The distutils package was the original standard library module in Python for building and installing other Python modules and extensions. However, it has been deprecated since Python 3.10 and was completely removed in Python 3.12 in favor of modern packaging tools like setuptools.

So the bundled Python for Mac and Windows is version 3.13 and will not have distutils.

[DiapDealer]

That IS strange. The bundled Python is checked by default on new Windows, macOS, and Linux AppImage installations. So if nobody ever unchecks the box, they will be using the bundled Python (even after updates. What's surprising is that I've never heard of Sigil's bundled Python throwing distutils errors on macOS--with ANY plugin. You should not have to uncheck the Use Bundled Python setting to get the epubcheck plugin to work on maOS.

EDIT: Never mind, it looks like I took too long to prepare my post. Doitsu's post has probably nailed the issue/solution.

[phillipgessert]

I'll update my version! Classic mistake.

[Doitsu]

FYI: in the latest EPUBCheck release, the devs have added a new parameter that'll output all messages: --maxOfEachMessage

If you want to test this new parameter, open plugin.py search for:

    # display status message

and change it to:

    args.extend(['--maxOfEachMessage', 'unlimited'])

    # display status message

(There need to be exactly 4 spaces before the new line.)

You can test it with this epub file.

Without the new parameter the plugin will output 71 messages. After adding the additional line, it'll output 3435 messages.

[Leonatus]

Linux Mint 22.3 Cinnamon, Sigil (AppImage) v. 2.8.1, Epubcheck v. 0.4.7.1.
I'm continuously using the plugin without issues, but recently I receive this message:

Status: failed

Update wird gesucht...

Traceback (most recent call last):
  File "/tmp/.mount_Sigil.OIPeJo/usr/share/sigil/plugin_launchers/python/launcher.py", line 142, in launch
    self.exitcode = target_script.run(container)
                    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^
  File "/home/juergen/.local/share/sigil-ebook/sigil/plugins/EpubCheck/plugin.py", line 282, in run
    if (latest_version and version) and (parse_version(latest_version) > parse_version(version)) or epc_files_not_found:
                                                                         ~~~~~~~~~~~~~^^^^^^^^^
  File "/home/juergen/.local/share/sigil-ebook/sigil/plugins/EpubCheck/packaging/version.py", line 277, in __init__
    raise InvalidVersion("Invalid version: '{0}'".format(version))
packaging.version.InvalidVersion: Invalid version: '5.4.0-fix'
Error: Invalid version: '5.4.0-fix'

What should I do, please?

[Kayadelenium]

Why not give epubveri a try?

Whether it’s a single book or hundreds—even thousands—of books, epubveri handles the task quickly. It is an EPUB validator written in pure Rust that is 100% compatible with epubcheck and adheres to standards.

Sigil plugin: https://github.com/veripublica/epubv...g/sigil-v0.3.4
Sigil plugin forum thread: https://www.mobileread.com/forums/sh...d.php?t=374939

[DiapDealer]

Originally Posted by Leonatus

Linux Mint 22.3 Cinnamon, Sigil (AppImage) v. 2.8.1, Epubcheck v. 0.4.7.1.
I'm continuously using the plugin without issues, but recently I receive this message:

Status: failed

Update wird gesucht...

Traceback (most recent call last):
  File "/tmp/.mount_Sigil.OIPeJo/usr/share/sigil/plugin_launchers/python/launcher.py", line 142, in launch
    self.exitcode = target_script.run(container)
                    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^
  File "/home/juergen/.local/share/sigil-ebook/sigil/plugins/EpubCheck/plugin.py", line 282, in run
    if (latest_version and version) and (parse_version(latest_version) > parse_version(version)) or epc_files_not_found:
                                                                         ~~~~~~~~~~~~~^^^^^^^^^
  File "/home/juergen/.local/share/sigil-ebook/sigil/plugins/EpubCheck/packaging/version.py", line 277, in __init__
    raise InvalidVersion("Invalid version: '{0}'".format(version))
packaging.version.InvalidVersion: Invalid version: '5.4.0-fix'
Error: Invalid version: '5.4.0-fix'

What should I do, please?

Looks like some version checking math failing on a weird returned version with text in it. In the preferences .json file, change

"update_check": true,

To

"update_check": false,

Until that unfortunate version number shakes itself out (or until Doitsu changes the plugin version checking code).

Also... always make sure you're running the very latest version of the EpubCheck plugin itself.

EDIT: I'm not seeing any "v5.4.0-fix" version for EpubCheck on their github page (the downloaded java program, not the Sigil plugin version). Not sure why/where that version would come from. Have you tried running the plugin again lately?

[Doitsu]

Originally Posted by DiapDealer

.0-fix" version for EpubCheck on their github page (the downloaded java program, not the Sigil plugin version).

That weird version number comes from my obviously inadequate version checking code. It searches for the version number in META-INF/maven/org.w3c/epubcheck/pom.xml

    <scm>
        <connection>scm:git:ssh://git@github.com:w3c/epubcheck.git</connection>
        <developerConnection>scm:git:ssh://git@github.com:w3c/epubcheckgit</developerConnection>
        <url>https://github.com/w3c/epubcheck</url>
        <tag>v5.4.0-fix</tag>
    </scm>

I'll try to upload a fixed version tomorrow.

@Leonatus Please disable the update check in the EpubCheck.json file.

  "github": false,
  "update_check": false,

[DiapDealer]

Oh, OK. So that's an internal version that's found within the epubcheck.jar itself then?

[Leonatus]

With the mentioned settings disabled it works again.