Request for More Flexible Dependency Requirements

[nihalshah-dev]

Hii maintainers🙋‍♂️,

Thanks for this amazing fork🤝

I'm currently using mkdocs-to-pdf==0.10.0 in a project where we have multiple MkDocs plugins. I've encountered dependency conflicts that make it challenging to use mkdocs-to-pdf alongside other plugins.

Current issue:

• mkdocs-to-pdf==0.10.0 strictly requires weasyprint==62.3
• weasyprint==62.3 strictly requires beautifulsoup4==4.9.3
• This creates conflicts with other plugins that require newer versions of beautifulsoup4 (>=4.12.0)

Specific example:

• mkdocs-inline-select-svg-plugin==0.1.0 requires beautifulsoup4>=4.12.0
• Currently impossible to use both plugins together due to pinned dependencies

Current workaround:

• I have temporarily uninstalled conflicting plugins to generate PDFs. but this isn't sustainable for production environments.

Would it be possible to:

1. Test if the plugin works with newer versions of dependencies?
2. Update the requirements to use version ranges instead of pinned versions where feasible?

This would greatly improve the plugin's compatibility with other MkDocs extensions and make it easier to maintain projects using multiple plugins.

Let me know if need anything else from me to resolve this issue!!

Awaiting your response😉

[domWalters]

Hi,

I decided to pin requirements whilst we were getting the repo stabilised, just to make completely sure that we didn't break anything and then have difficulty finding the issue.

I'm perfectly happy to relax all of the == requirements personally, assuming nothing breaks.

Due to issues with newer weasyprint we would have to do a < requirement for it and one of its dependencies, but everything else I think can >.

[hkato]

I requested a downgrade for this issue. #42 #43

#57 WasyPrint v65.0

• Admonitions icon layout
• Cover page layout

However, I think specifying '>=' would also be fine.

If we have problems with WeasyPrint, we can install it using the following method.

pip install mkdocs-to-pdf weasyprint==62.3 pydyf==0.10.0

-    "weasyprint == 62.3",
-    "pydyf == 0.10.0",
+    "weasyprint >= 62.3",
+    "pydyf >= 0.10.0",

[Thiti517]

Hey!

Current issue:

• mkdocs-to-pdf==0.10.0 strictly requires weasyprint==62.3
• weasyprint==62.3 strictly requires beautifulsoup4==4.9.3
• This creates conflicts with other plugins that require newer versions of beautifulsoup4 (>=4.12.0)

Just to clarify: weasyprint==62.3 does not require beautifulsoup4 at all.
(See pyproject.toml for version 62.3 under dependencies.)

The actual issue is that mkdocs-to-pdf==0.10.0 does strictly require beautifulsoup4==4.9.3.
It's this project's dependency that causes issues when you need a newer version of beautifulsoup4.

I would recommend changing the dependency in mkdocs-to-pdf to:

dependencies = [
  "beautifulsoup4 >= 4.9.3"
]

This would allow compatibility with newer versions.

As for weasyprint, keeping the pin at ==62.3 ensures logo cover generation continues to work as expected.
If you choose to loosen the version constraint to weasyprint>=62.3, it should be clearly documented that versions above 62.3 are to be used at the user's own risk, as newer versions may break certain features.

[hkato]

Sorry,

This would allow compatibility with newer versions.

I understand.

[Thiti517]

No problem locking dependency versions. It was a good practice at the start of the project to ensure starting with a solid base.

However, since there seems to be no known issue with beautifulsoup4, the strict versioning of this dependency should be relaxed in the next version of the plugin (or even in a minor 0.10.1 version).

As for weasyprint in my opinion it should be kept to strict version until a workaround or solution could be found for logo on cover, but i could be wrong.

⚠NOTE

Same thing should be done with mkdocs and libsass.
At current time this plugin is using last version of both but in futur it would prevent user from using newer version.

[domWalters]

I should have some time on Tuesday evening to make some progress on this repo.

I've not really had much time the last few weeks, but should get some before Saturday.

[nihalshah-dev]

The actual issue is that mkdocs-to-pdf==0.10.0 does strictly require beautifulsoup4==4.9.3. It's this project's dependency that causes issues when you need a newer version of beautifulsoup4.

I would recommend changing the dependency in mkdocs-to-pdf to:

dependencies = [
"beautifulsoup4 >= 4.9.3"
]
This would allow compatibility with newer versions.

As for weasyprint, keeping the pin at ==62.3 ensures logo cover generation continues to work as expected. If you choose to loosen the version constraint to weasyprint>=62.3, it should be clearly documented that versions above 62.3 are to be used at the user's own risk, as newer versions may break certain features.

This completely makes sense now, also it will eliminate the other plugin dependency error specifically in my case . this one - mkdocs-inline-select-svg-plugin==0.1.0 requires beautifulsoup4 >= 4.12.0

For a temp fix i have tweaked my pyproject.toml to look like -

dependencies = [
  "weasyprint<=65.0",
  "beautifulsoup4 <= 4.13.3",
  "mkdocs-to-pdf >= 0.10.0",
  #mkdocs-inline-select-svg-plugin==0.1.0           ##removed
]

This works for me in my feature branch, but i am waiting for the flexible release of your plugin to merge it into my main.

Hopefully soon now i guess 🙂

[nihalshah-dev]

any updates? @domWalters , @hkato

[hkato]

@nihalshah-dev

It seems @domWalters is very busy now?

I created PR #69 . We should wait for him.
#69 includes @Thiti517 suggestion about libsass and mkdocs

For now, please install using the following method.

pip install \
    git+https://github.com/domWalters/mkdocs-to-pdf.git@64-flexible-dependency \
    mkdocs-inline-select-svg-plugin