Add prototype script for validating example execution#362
Closed
Tushar1733 wants to merge 5 commits intomesa:mainfrom
Closed
Add prototype script for validating example execution#362Tushar1733 wants to merge 5 commits intomesa:mainfrom
Tushar1733 wants to merge 5 commits intomesa:mainfrom
Conversation
for more information, see https://pre-commit.ci
…3/mesa-examples into mesa-example-validator
Some examples are failing they can't run by "python app.py" command. therefore i am adding "solara run app.py" since all the new examples are compatible with this .
3781711 to
d845055
Compare
Author
|
hey @EwoutH can you review it real quick ?feedback will help me improve it |
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
This PR introduces a prototype script for validating whether examples in the Mesa Examples repository execute successfully.
As Mesa evolves, some examples may break due to API changes, missing dependencies, or outdated documentation. This script demonstrates a possible approach for automatically identifying such issues.
The script:
app.pyvalidation_report.txtThe goal of this prototype is to explore how automated validation of examples could be implemented in the future, potentially as part of a CI workflow.
Added Files
scripts/run_examples.py
scripts/README.md
Motivation
While auditing examples locally (≈20 examples), I noticed several recurring issues:
Automating example validation could help detect these issues earlier and improve the long-term maintainability of the examples repository.
Future Work
Possible next steps could include:
solara run app.py(Done)Hii @jackiekazil @EwoutH just checking in to see if you had time to review the validator prototype. Feedbacks will help me to improve it further.