fix: add missing core dependencies and macOS installation troubleshooting guide#421
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: aryunewaskar77-art The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @aryunewaskar77-art! It looks like this is your first PR to kubeedge/ianvs 🎉 |
kubeedge-bot
added
the
size/M
aryunewaskar77-art
force-pushed
the
fix/missing-core-dependencies-requirements
branch
from
f53db30 to
a03391b
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Ianvs installation guide by adding a troubleshooting section for macOS/Linux and a recommended installation sequence. It also adds colorlog and PyYAML to the requirements.txt file. Feedback from the review suggests removing redundant troubleshooting steps for dependencies now included in the requirements file, using the ianvs command for installation verification, and improving the formatting of the command sequence with a bash code block.
| pip install ./examples/resources/third_party/* | ||
| pip install -r requirements.txt | ||
| pip install -e . | ||
| python benchmarking.py --help No newline at end of file |
There was a problem hiding this comment.
Since the installation process includes pip install -e ., it is better to verify the installation using the ianvs command-line tool directly. This confirms that the entry point was correctly installed in the environment's PATH. Additionally, please consider wrapping this entire command sequence (lines 106-112) in a markdown code block (e.g., using ```bash) to improve readability and allow users to easily copy the commands.
| python benchmarking.py --help | |
| ianvs --help |
kubeedge-bot
added
do-not-merge/invalid-commit-message
aryunewaskar77-art
force-pushed
the
fix/missing-core-dependencies-requirements
branch
from
4a255b1 to
e8e3552
Compare
kubeedge-bot
added
size/M
- Remove colorlog and PyYAML manual fix instructions as they are now covered by requirements.txt - Replace python benchmarking.py --help with ianvs --help to verify installation via the installed entry point - Wrap install sequence in bash code block for readability Signed-off-by: Aaryaa Newaskar <aryu.newaskar77@gmail.com>
aryunewaskar77-art
force-pushed
the
fix/missing-core-dependencies-requirements
branch
from
e8e3552 to
40987b7
Compare
|
/assign @MooreZheng |
3 participants
What this PR does
Fixes missing dependencies that cause
ModuleNotFoundErroron every fresh install, and adds a troubleshooting section to the installation guide documenting thesednaversion conflict.Problem
New contributors attempting a fresh install hit the following errors in sequence with no guidance:
ModuleNotFoundError: No module named 'colorlog'ModuleNotFoundError: No module named 'yaml'ModuleNotFoundError: No module named 'sedna'(PyPI version too old)ImportError: cannot import name 'JsonlDataParse' from 'sedna.datasources'None of these are documented anywhere. The correct fix (using the bundled sedna wheel) is not mentioned in the install guide.
Changes
requirements.txt: addedcolorlog>=4.7.2andPyYAML>=6.0docs/guides/how-to-install-ianvs.md: added troubleshooting section covering all three issues and a recommended install sequence for macOSVerification
Verified working on:
python benchmarking.py --help # output: usage: ianvs [-h] [-f [BENCHMARKING_CONFIG_FILE]] [-v]Related issues
Related to #230