Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run_demo.py not tested, maybe remove #67

Open
lukpueh opened this issue Jan 17, 2024 · 2 comments
Open

run_demo.py not tested, maybe remove #67

lukpueh opened this issue Jan 17, 2024 · 2 comments

Comments

@lukpueh
Copy link
Member

lukpueh commented Jan 17, 2024

To test the demo automatically, e.g. on in-toto update, we extract and run the cli snippets in README.md and check the output with run_demo_md.py.

run_demo.py, on the other hand, was meant to verbosely walk through the demo, e.g. in a presentation (and to clean up the demo workbench).

However, run_demo.py must be synced with README manually, which is easily missed, because the script is not tested automatically.

I assume that the demo has become less relevant in presentations, but mostly used as in-toto getting started, for which the tested README should be sufficient.

Shall we just remove run_demo.py? Otherwise I recommend to also test it automatically.

@tonylturner
Copy link

FYI we do personally find run_demo.py helpful as we use this project in a supply chain course and some of my students are not very technical and benefit from just running this script.

@lukpueh
Copy link
Member Author

lukpueh commented May 13, 2024

Thanks for the feedback. That's great to hear. Let's keep it and add tests then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants