Clean up requirements.txt file(s) #871
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
schaubh
added
documentation
|
@dpad , you mentioned the need to clean up |
cmake version is already checked in src/CMakeList.txt
The variable required_conan_version defines the required version of conan in this file. No need to duplicate this checking.
all build required dependencies are move to this new file
Move the documentation related packages to requirements_doc.txt, and the other optional packages are now part of the regular requirements.txt file. The wheel build option to include additional packages is really not needed. If using the allOptPkg flag now the documentation related packages are installed
pkg_resources is deprecated and was throwing warnings.
schaubh
force-pushed
the
feature/requirements_update
branch
from
f9d58a3 to
00ab5e0
Compare
andrewmorell
requested changes
Dec 11, 2024
- the RST document on optional packages is no longer needed - the documentation on using `pre-commit` and `clang-format` is now moved to the coding guidelines RST file. This is a better place for this. - update table description of the `allOptPkg` flag - moved RST file to create BSK documentation to inside the Developer folder - updated RST on creating the BSK documentation to discuss loading required packages from requirements_doc.txt
Users should just load all packages defined in requirements_dev.txt before building BSK. This ensures all the build related requirements are satisfied.
This package wasn't being use by any of the BSK test or example scripts. Further, the current dask-expr is no longer compatible with Python 3.8. Thus, this is being removed now from the BSK requirements.
As pytest and pytest-xdist are no longer in requirements.txt, we need to install these manually in this test script.
schaubh
force-pushed
the
feature/requirements_update
branch
from
00ab5e0 to
1023c61
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The
requirements.txthad a mixture of BSK run-time python package requirements, but also requirements to build BSK that didn't belong in this file. Now, therequirements.txtfile only contains python packages required to run BSK along with the examples files.The packages required to build BSK from source are moved to
requirements_dev.txt. This simplifies the BSK install instructions to use::If the build packages change, or their version requirements change, we can readily address that in this file without having to change the install instructions.
All packages to build the RST documentation are moved to the new
requirements_doc.txtfile. Therequirements_optional.txtfile is no longer needed. Only a small number of packages were left to run particular examples, and these are moved torequirements.txt.Verification
Did a clean build and BSK compiled from scratch without issues. The CI build scripts are updated to use the
requirements_dev.txtfile and build across all platforms and python versions.Documentation
The BSK Documentation files have been updated to discuss the install instructions and the instructions how to build the documentation. The mention of
requirements_optional.txthave been removed.Future work
None at this time.