Skip to content

Commit

Permalink
pw_docgen: Include required Python packages
Browse files Browse the repository at this point in the history
This adds the missing beautifulsoup4, jsonschema and kconfiglib
packages to pw_docgen/py/setup.cfg. All are imported in pw_docgen code
and not upstream-only dependencies. Moved the pinned version numbers
out of pigweed_upstream_requirements.txt and into constraint.list.

Also remove pytz and psutil out of pigweed_upstream_requirements.txt,
they are in constraint.list already and not upstream-only packages.

Change-Id: I26550548569a3c11dc196f337a5cc0f044dd0e6f
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237334
Docs-Not-Needed: Anthony DiGirolamo <[email protected]>
Reviewed-by: Dave Roth <[email protected]>
Commit-Queue: Anthony DiGirolamo <[email protected]>
Lint: Lint 🤖 <[email protected]>
  • Loading branch information
AnthonyDiGirolamo authored and CQ Bot Account committed Sep 23, 2024
1 parent 85469bd commit 751a5ae
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 18 deletions.
8 changes: 6 additions & 2 deletions pw_docgen/py/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ description = Generate Sphinx documentation
packages = find:
zip_safe = False
install_requires =
sphinx>=5.3.0
beautifulsoup4
jsonschema
kconfiglib
pytz
sphinx-argparse
sphinxcontrib-mermaid>=0.7.1
sphinx-design>=0.3.0
sphinx>=5.3.0
sphinxcontrib-mermaid>=0.7.1
websockets


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ astroid==3.0.1
asttokens==2.4.0
babel==2.12.1
backcall==0.2.0
beautifulsoup4==4.12.2
black==23.1.0
cachetools==5.0.0
certifi==2021.10.8
Expand Down Expand Up @@ -37,6 +38,7 @@ isort==5.10.1
jedi==0.19.1
Jinja2==3.1.2
json5==0.9.11
jsonschema==4.23.0
lockfile==0.12.2
kconfiglib==14.1.0
markupsafe==2.1.3
Expand Down Expand Up @@ -67,7 +69,6 @@ pyperclip==1.8.2
pyserial==3.5
python-daemon==3.0.1
pytz==2023.3
pyusb==1.2.1
pyyaml==6.0.1
requests==2.31.0
rsa==4.8
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@ backcall==0.2.0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# ipython
beautifulsoup4==4.12.2 \
--hash=sha256:492bbc69dca35d12daac71c4db1bfff0c876c00ef4a2ffacce226d4638eb72da \
--hash=sha256:bd2520ca0d9d7d12694a53d44ac482d181b4ec1888909b035a3dbf40d0f57d4a
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
black==23.1.0 \
--hash=sha256:0052dba51dec07ed029ed61b18183942043e00008ec65d5028814afaab9a22fd \
--hash=sha256:0680d4380db3719ebcfb2613f34e86c8e6d15ffeabcf8ec59355c5e7b85bb555 \
Expand Down Expand Up @@ -700,6 +704,10 @@ jsonschema-specifications==2023.12.1 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# jsonschema
kconfiglib==14.1.0 \
--hash=sha256:bed2cc2216f538eca4255a83a4588d8823563cdd50114f86cf1a2674e602c93c \
--hash=sha256:edcd35a20e7e138a9a9e96149027f805f785e818d2eae400b6fa8b0c8845114a
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
lockfile==0.12.2 \
--hash=sha256:6aed02de03cba24efabcd600b30540140634fc06cfa603822d508d5361e9f799 \
--hash=sha256:6c3cb24f344923d30b2785d5ad75182c8ea7ac1b6171b08657258ec7429d50fa
Expand Down Expand Up @@ -1086,6 +1094,10 @@ python-dateutil==2.9.0.post0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# pykwalify
pytz==2023.3 \
--hash=sha256:1d8ce29db189191fb55338ee6d0387d82ab59f3d00eac103412d64e0ebd0c588 \
--hash=sha256:a151b3abb88eda1d4e34a9814df37de2a80e301e68ba0fd856fb9b46bfbbbffb
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
pyyaml==6.0.1 \
--hash=sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5 \
--hash=sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc \
Expand Down Expand Up @@ -1341,6 +1353,12 @@ snowballstemmer==2.2.0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# sphinx
soupsieve==2.6 \
--hash=sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb \
--hash=sha256:e72c4ff06e4fb6e4b5a9f0f55fe6e81514581fca1515028625d0f299c602ccc9
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# beautifulsoup4
sphinx==7.1.2 \
--hash=sha256:780f4d32f1d7d1126576e0e5ecc19dc32ab76cd24e950228dcf7b1f6d3d9e22f \
--hash=sha256:d170a81825b2fcacb6dfd5a0d7f578a053e45d3f2b153fecc948c37344eb4cbe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@ backcall==0.2.0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# ipython
beautifulsoup4==4.12.2 \
--hash=sha256:492bbc69dca35d12daac71c4db1bfff0c876c00ef4a2ffacce226d4638eb72da \
--hash=sha256:bd2520ca0d9d7d12694a53d44ac482d181b4ec1888909b035a3dbf40d0f57d4a
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
black==23.1.0 \
--hash=sha256:0052dba51dec07ed029ed61b18183942043e00008ec65d5028814afaab9a22fd \
--hash=sha256:0680d4380db3719ebcfb2613f34e86c8e6d15ffeabcf8ec59355c5e7b85bb555 \
Expand Down Expand Up @@ -694,6 +698,10 @@ jsonschema-specifications==2023.12.1 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# jsonschema
kconfiglib==14.1.0 \
--hash=sha256:bed2cc2216f538eca4255a83a4588d8823563cdd50114f86cf1a2674e602c93c \
--hash=sha256:edcd35a20e7e138a9a9e96149027f805f785e818d2eae400b6fa8b0c8845114a
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
lockfile==0.12.2 \
--hash=sha256:6aed02de03cba24efabcd600b30540140634fc06cfa603822d508d5361e9f799 \
--hash=sha256:6c3cb24f344923d30b2785d5ad75182c8ea7ac1b6171b08657258ec7429d50fa
Expand Down Expand Up @@ -1080,6 +1088,10 @@ python-dateutil==2.9.0.post0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# pykwalify
pytz==2023.3 \
--hash=sha256:1d8ce29db189191fb55338ee6d0387d82ab59f3d00eac103412d64e0ebd0c588 \
--hash=sha256:a151b3abb88eda1d4e34a9814df37de2a80e301e68ba0fd856fb9b46bfbbbffb
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
pyyaml==6.0.1 \
--hash=sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5 \
--hash=sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc \
Expand Down Expand Up @@ -1335,6 +1347,12 @@ snowballstemmer==2.2.0 \
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# sphinx
soupsieve==2.6 \
--hash=sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb \
--hash=sha256:e72c4ff06e4fb6e4b5a9f0f55fe6e81514581fca1515028625d0f299c602ccc9
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# beautifulsoup4
sphinx==7.1.2 \
--hash=sha256:780f4d32f1d7d1126576e0e5ecc19dc32ab76cd24e950228dcf7b1f6d3d9e22f \
--hash=sha256:d170a81825b2fcacb6dfd5a0d7f578a053e45d3f2b153fecc948c37344eb4cbe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,11 @@ backcall==0.2.0 \
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
# ipython
beautifulsoup4==4.12.2 \
--hash=sha256:492bbc69dca35d12daac71c4db1bfff0c876c00ef4a2ffacce226d4638eb72da \
--hash=sha256:bd2520ca0d9d7d12694a53d44ac482d181b4ec1888909b035a3dbf40d0f57d4a
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
black==23.1.0 \
--hash=sha256:0052dba51dec07ed029ed61b18183942043e00008ec65d5028814afaab9a22fd \
--hash=sha256:0680d4380db3719ebcfb2613f34e86c8e6d15ffeabcf8ec59355c5e7b85bb555 \
Expand Down Expand Up @@ -704,6 +709,10 @@ jsonschema-specifications==2023.12.1 \
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
# jsonschema
kconfiglib==14.1.0 \
--hash=sha256:bed2cc2216f538eca4255a83a4588d8823563cdd50114f86cf1a2674e602c93c \
--hash=sha256:edcd35a20e7e138a9a9e96149027f805f785e818d2eae400b6fa8b0c8845114a
# via -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
lockfile==0.12.2 \
--hash=sha256:6aed02de03cba24efabcd600b30540140634fc06cfa603822d508d5361e9f799 \
--hash=sha256:6c3cb24f344923d30b2785d5ad75182c8ea7ac1b6171b08657258ec7429d50fa
Expand Down Expand Up @@ -1084,6 +1093,10 @@ python-dateutil==2.9.0.post0 \
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
# pykwalify
pytz==2023.3 \
--hash=sha256:1d8ce29db189191fb55338ee6d0387d82ab59f3d00eac103412d64e0ebd0c588 \
--hash=sha256:a151b3abb88eda1d4e34a9814df37de2a80e301e68ba0fd856fb9b46bfbbbffb
# via -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
pyyaml==6.0.1 \
--hash=sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5 \
--hash=sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc \
Expand Down Expand Up @@ -1339,6 +1352,12 @@ snowballstemmer==2.2.0 \
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
# sphinx
soupsieve==2.6 \
--hash=sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb \
--hash=sha256:e72c4ff06e4fb6e4b5a9f0f55fe6e81514581fca1515028625d0f299c602ccc9
# via
# -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
# beautifulsoup4
sphinx==7.1.2 \
--hash=sha256:780f4d32f1d7d1126576e0e5ecc19dc32ab76cd24e950228dcf7b1f6d3d9e22f \
--hash=sha256:d170a81825b2fcacb6dfd5a0d7f578a053e45d3f2b153fecc948c37344eb4cbe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,12 @@

# Pigweed upstream specific dependencies:
# pigweed.dev Sphinx themes
beautifulsoup4==4.12.2
sphinx-copybutton==0.5.1
breathe==4.35.0
kconfiglib==14.1.0
pydata-sphinx-theme==0.15.4
pytz==2023.3
sphinx-reredirects==0.1.3
sphinx-sitemap==2.5.1
jsonschema==4.21.1
# Renode requirements
psutil==5.9.4
robotframework==6.0.2
# RP2040 utils.
pyusb==1.2.1
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ beautifulsoup4==4.12.2 \
--hash=sha256:bd2520ca0d9d7d12694a53d44ac482d181b4ec1888909b035a3dbf40d0f57d4a
# via
# -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
# furo
# pydata-sphinx-theme
black==23.1.0 \
--hash=sha256:0052dba51dec07ed029ed61b18183942043e00008ec65d5028814afaab9a22fd \
Expand Down Expand Up @@ -710,9 +709,9 @@ json5==0.9.11 \
--hash=sha256:1aa54b80b5e507dfe31d12b7743a642e2ffa6f70bf73b8e3d7d1d5fba83d99bd \
--hash=sha256:4f1e196acc55b83985a51318489f345963c7ba84aa37607e49073066c562e99b
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
jsonschema==4.21.1 \
--hash=sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f \
--hash=sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5
jsonschema==4.23.0 \
--hash=sha256:d71497fef26351a33265337fa77ffeb82423f3ea21283cd9467bb03999266bc4 \
--hash=sha256:fbadb6f8b144a8f8cf9f0b89ba94501d143e50411a1278633f56a7acf7fd5566
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
jsonschema-specifications==2023.12.1 \
--hash=sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -703,9 +703,9 @@ json5==0.9.11 \
--hash=sha256:1aa54b80b5e507dfe31d12b7743a642e2ffa6f70bf73b8e3d7d1d5fba83d99bd \
--hash=sha256:4f1e196acc55b83985a51318489f345963c7ba84aa37607e49073066c562e99b
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
jsonschema==4.21.1 \
--hash=sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f \
--hash=sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5
jsonschema==4.23.0 \
--hash=sha256:d71497fef26351a33265337fa77ffeb82423f3ea21283cd9467bb03999266bc4 \
--hash=sha256:fbadb6f8b144a8f8cf9f0b89ba94501d143e50411a1278633f56a7acf7fd5566
# via -r /python/gen/pw_env_setup/pigweed_build_venv/compiled_requirements.txt
jsonschema-specifications==2023.12.1 \
--hash=sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -713,9 +713,9 @@ json5==0.9.11 \
--hash=sha256:1aa54b80b5e507dfe31d12b7743a642e2ffa6f70bf73b8e3d7d1d5fba83d99bd \
--hash=sha256:4f1e196acc55b83985a51318489f345963c7ba84aa37607e49073066c562e99b
# via -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
jsonschema==4.21.1 \
--hash=sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f \
--hash=sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5
jsonschema==4.23.0 \
--hash=sha256:d71497fef26351a33265337fa77ffeb82423f3ea21283cd9467bb03999266bc4 \
--hash=sha256:fbadb6f8b144a8f8cf9f0b89ba94501d143e50411a1278633f56a7acf7fd5566
# via -r \python\gen\pw_env_setup\pigweed_build_venv\compiled_requirements.txt
jsonschema-specifications==2023.12.1 \
--hash=sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc \
Expand Down

0 comments on commit 751a5ae

Please sign in to comment.