This is an automated archive made by the Lemmit Bot.
The original was posted on /r/opensource by /u/basnijholt on 2025-01-06 04:27:19+00:00.
What My Project Does
Tuitorial lets you create interactive code tutorials that run in your terminal. The key insight is that you define your code ONCE, then create multiple views highlighting different parts using pattern matching rules - no more copy-pasting code snippets across slides! Features include:
- Write code once, create multiple highlighted views
- Interactive step-by-step navigation
- Rich syntax highlighting
- Support for Markdown and even images
- Configure via Python or YAML
- Live reload for quick iterations
Here’s a quick demo: which runs this YAML format presentation pipefunc.yaml
Target Audience
This is for the 0.1% of people who:
- Are giving technical presentations or workshops
- Love terminal-based tools
- Are tired of copying the same code into multiple PowerPoint slides
- Want version-controlled, reproducible tutorials
It’s particularly useful for teaching scenarios where you want to focus attention on specific parts of code while keeping everything in context.
Comparison to Existing Alternatives
The problem with traditional tools:
- PowerPoint/Google Slides: Forces you to copy-paste code multiple times just to highlight different parts
- Jupyter notebooks: Great for readers, but during presentations there’s too much text for the audience to get distracted by
- Spiel: While also terminal-based, it’s more for general presentations without code-specific features
- REPLs: Interactive but lack structured presentation
- Many others linked in this issue, all general purpose terminal presentation tools
Tuitorial solves these issues by letting you define code once and create multiple views through highlighting rules, all while staying in the familiar terminal environment.
The project started as a solution to my own frustration while trying to present another package I built (pipefunc). Sometimes the best tools come from scratching your own itch!
Check it out: