Repository navigation
fix(dashboard): ensure repository root is in sys.path for app startup - #16
Merged
Merged
Conversation
This file contains hidden or 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
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.
Summary
sys.pathupondashboard/app.pyexecution.ModuleNotFoundError: No module named 'dashboard'when launching the app viastreamlit run .\dashboard\app.py.Motivation
When invoking
streamlit run .\dashboard\app.py, Streamlit's script runner bootstrap prepends the target script's parent directory (dashboard/) tosys.path[0]. Because modules acrossdashboard/use package-level imports likefrom dashboard.components.sidebar import ..., Python fails to locatedashboardas a top-level package unless the project root is explicitly present onsys.path.Key Changes
dashboard/app.py:_PROJECT_ROOT = str(Path(__file__).resolve().parent.parent).sys.path.insert(0, _PROJECT_ROOT)before loading dashboard subcomponents.Verification
ruff check .passed with 0 errorsruff format --check .passed cleanly (105 files already formatted)python -m unittest discover testspassed with 22/22 tests passing and 0 failuresstreamlit run .\dashboard\app.pyresolves package imports without error