Skip to content

Conversation

dnwe
Copy link
Contributor

@dnwe dnwe commented Jun 3, 2024

Currently sphinx-rtd-theme is incorrectly being included in the main group dependencies and hence pulls in itself and sphinx as a runtime dep for the client. Declaring it in the docs group ensures it is only installed if the sdcclient[docs] is installed.

Not only does this pull in a number of unnecessary dependencies, it also forces a backlevel urllib3 1.x to be used. Here's the before and after this PR of a pip install sdcclient into an empty venv:

@@ -1,29 +1,12 @@
 Package                       Version
 ----------------------------- --------
-alabaster                     0.7.16
-babel                         2.15.0
 certifi                       2024.6.2
 charset-normalizer            3.3.2
-docutils                      0.17.1
 idna                          3.7
-imagesize                     1.4.1
-jinja2                        3.1.4
-markupsafe                    2.1.5
-packaging                     24.0
 pyaml                         21.10.1
-pygments                      2.18.0
 pyyaml                        6.0.1
 requests                      2.32.3
-requests-toolbelt             0.9.1
+requests-toolbelt             1.0.0
 sdcclient                     0.17.1
-snowballstemmer               2.2.0
-sphinx                        5.3.0
-sphinx-rtd-theme              1.0.0
-sphinxcontrib-applehelp       1.0.8
-sphinxcontrib-devhelp         1.0.6
-sphinxcontrib-htmlhelp        2.0.5
-sphinxcontrib-jsmath          1.0.1
-sphinxcontrib-qthelp          1.0.7
-sphinxcontrib-serializinghtml 1.1.10
 tatsu                         5.8.3
-urllib3                       1.26.18
+urllib3                       2.2.1

Currently sphinx-rtd-theme is incorrectly being included in the main
group dependencies and hence pulls in itself and sphinx as a runtime dep
for the client. Declaring it in the docs group ensures it is only
installed if the `sdcclient[docs]` is installed.

Signed-off-by: Dominic Evans <[email protected]>
@ctolon22 ctolon22 requested a review from nenper June 4, 2024 09:40
@dnwe
Copy link
Contributor Author

dnwe commented Aug 12, 2024

@nenper 👋🏻 please can you take a look at this small PR?

Copy link
Collaborator

@nenper nenper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dnwe - Thank you for the submission. Approved, this change makes perfect sense.

@nenper nenper merged commit 9d18376 into sysdiglabs:master Oct 2, 2024
@dnwe
Copy link
Contributor Author

dnwe commented Oct 2, 2024

@nenper thank you!

@dnwe
Copy link
Contributor Author

dnwe commented Oct 2, 2024

@nenper if possible, please could you also arrange for a release version to be cut and uploaded to PyPi with this change?

@dnwe dnwe deleted the no-sphinx-dep branch October 2, 2024 09:12
@dnwe
Copy link
Contributor Author

dnwe commented May 6, 2025

@nikola-milikic 🎉 thanks! I see v0.18.0 was released and also pushed to pypi too, that's great!

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