A terminal-based presentation tool with colors and effects

https://github.com/vinayak-mehta/present

by submeta • 6 years ago

342 49 6 years ago

vortex_ape20• 6 years ago

Hey, author here! Just wanted to add that you can write your slides using Markdown (most of its features are supported).

Also reposting my comment from the asciimatics post that was here yesterday:

I made this on top of asciimatics, which is awesome! I had a lot of fun making this thanks to all the effects asciimatics already has.

I was also able to extend an internal asciimatics class to add a feature for pre-recorded playable code blocks. It lets you play code in your terminal presentation like someone's typing it! You can learn more about it here: https://present.readthedocs.io/en/latest/codio.html

stojano• 6 years ago

love it... thanks

vortex_ape20• 6 years ago

Glad you liked it!

vortex_ape20• 6 years ago

PS: I've been wanting to build this ever since I watched Brandon Rhodes' North Bay Python 2017 keynote! https://www.youtube.com/watch?v=rrMnmLyYjU8

It's a talk about (in Brandon's words) ASCII art animation, software architecture, the mysteries of UNIX terminal settings, and the glories of Plain Text. You should totally check it out!

vortex_ape20• 6 years ago

PPS: In case you're interested in speaker notes, I used `present` + tmux + a keylogger + reveal.js speaker notes view for a presentation last week. I posted about it here: https://vinayak.io/2020/08/24/day-11-reveal-keylogger-tmux-p...

Though I want to work on a terminal-based speaker notes view some time! https://github.com/vinayak-mehta/present/issues/5

lanna• 6 years ago

I created a similar REPL presentation tool for Scala: https://github.com/marconilanna/REPLesent

swyx4• 6 years ago

i gotta say, every time i see a bay area python meetup on youtube, it's always super high quality. as someone who doesnt live in the bay area, i am very jealous. please pass along my compliments to organizers and i wish i could replicate it in my city.

TedDoesntTalk• 6 years ago

How did you do the matrix raining code in the demo? I did not see it in the examples. I use an mp4 of that as a screen saver but would love it in terminal instead!

vortex_ape20• 6 years ago

You can use the matrix effect by adding `` to the top of your slide! :)

These effects are supported right now: fireworks, explosions, stars, matrix, plasma. I plan to add more asciimatics effects soon!

vicnicius• 6 years ago

You mean like this? https://github.com/abishekvashok/cmatrix

Macuyiko• 6 years ago

Relies on the asciimatics Matrix effect, looks like: https://github.com/peterbrittain/asciimatics/blob/master/asc...

m3at• 6 years ago

Here is how to do it with a few lines of bash:

  function matrix () {
      echo -e "\e[1;40m"
      clear
      while :; do
          echo $LINES $COLUMNS $(( $RANDOM % $COLUMNS)) $(( $RANDOM % 72 ))
          sleep 0.05
      done|awk '{
          letters="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん@#$%^&*()";
          c=$4; letter=substr(letters,c,1);a[$3]=0;for (x in a) {o=a[x];a[x]=a[x]+1; printf "\033[%s;%sH\033[2;32m%s",o,x,letter;
          printf "\033[%s;%sH\033[1;37m%s\033[0;0H",a[x],x,letter;if (a[x] >= $1) { a[x]=0; } }
      }'
  }

swyx4• 6 years ago

could i ask about more details on shipping this? what made you start working on it? how long did you work on it to an initial state? have you had any practical work-related side benefits of doing something like this, or is it pure hobby?

vortex_ape20• 6 years ago

I started working on this at the Recurse Center two weeks ago.

As for practical work-related side benefits, I've neither had my open-source work weigh in on the hiring process (as everyone still asks algorithms/data structures questions) nor earned much money through it. But I love building open-source tools that would be useful for people, including me (I used `present` for a talk some days ago), so you could say it's just a hobby at this point.

BOOSTERHIDROGEN• 6 years ago

I cant running this apps

  \appdata\local\programs\python\python38\lib\runpy.py", line 194, in _run_module_as_main
    return _run_code(code, main_globals, None,

vortex_ape20• 6 years ago

Can you raise an issue with some detail on how you installed it along with the full traceback? https://github.com/vinayak-mehta/present/issues Your OS, Python version and terminal emulator details will also help.

I'll take a look!

szszrk2• 6 years ago

Hey! It's super cool, but can't work it out how to run this on a few environemnts. Tried Ubuntu and centos, always get ModuleNotFoundError: No module named 'dataclasses'.

Centos 8.2, Python 3.6.8, present Version: 0.4.0, pip 9.0.3. Tried with global and user install in pip. Not really a python dev, more of a user :)

szszrk2• 6 years ago

I just found some issues on it on github, will try to sort it out, sorry for calling here first, just expected all dependencies to be there and didn't realized "dataclasses" could be a project name!:)

catmistake• 6 years ago

Those special f/x are really slick. Always nice to see new Terminal development.

JakeWesorick• 6 years ago

Nice! Something similar but maybe not so extreme is Deck Set. https://www.deckset.com/

Write markdown and it does the design for you.

vortex_ape20• 6 years ago

I love how DeckSet looks but it only works on macOS :\

laurentoget• 6 years ago

Only for MacOS though

lazzlazzlazz• 6 years ago

DeckSet is great, but is quite limited in terms of allowing theme customization. If they allowed themes to be modified directly with CSS — or better, YAML/TOML/JSOn, that'd be excellent.

I've been looking very closely at Marp[1], which is a engineer-focused solution to this.

[^1] https://github.com/marp-team/marp

captn3m0• 6 years ago

Used it last week for a presentation. Loved it.

vortex_ape20• 6 years ago

Thanks again! I loved that presentation! Looking forward to a longer one :D

dividedbyzero• 6 years ago

Can it do a PDF export? I'm usually providing a PDF of my slides with some comments, as people pretty much always request that if I don't.

vortex_ape20• 6 years ago

Not currently. A lot of people have requested that feature, I'll look into how that can be done! Tracking it here: https://github.com/vinayak-mehta/present/issues/43

andy99• 6 years ago

Made me think of this that I have used previously: http://suso.suso.org/xulu/Shellshow

I had played with writing a pandoc filter that would add formatting escape sequences based on markdown, your tool does a better job than where I got to.

One thing I want in a tool like this is to be able to display ascii charts like from gnuplot, which is why I liked the simplicity of Shellshow. I will have to dig in to see if this is possible, if not I expect it would be easy to add.

vortex_ape20• 6 years ago

Thanks for pointing me to Shellshow, I hadn't heard of it before, it looks cool! I'll look into it in detail sometime this week and see if I can add some of its features to `present`.

One thing I want in a tool like this is to be able to display ascii charts like from gnuplot, which is why I liked the simplicity of Shellshow. I will have to dig in to see if this is possible, if not I expect it would be easy to add.

I've thought about adding charting features too! Asciimatics supports barcharts: https://asciimatics.readthedocs.io/en/stable/asciimatics.htm... and lets you extend classes to build other types of charts too.

Would you like to open an issue and describe this feature a bit in detail? https://github.com/vinayak-mehta/present/issues For example, what should the API look like, should it pick up data from a csv file and load it up into a barchart etc. I would love to work on this when I find time!

Pirate-of-SV• 6 years ago

What tool(s) did you use to record the example gifs in the readme?

vortex_ape20• 6 years ago

I used https://github.com/phw/peek but I plan on trying asciinema / terminalizer soon.

I was able to record `present` with asciinema, just need to see how nicely it renders into a GIF!

auscompgeek• 6 years ago

You may be interested in https://nbedos.github.io/termtosvg/ - it can take asciinema recordings and turn them into animated SVGs.

dheera• 6 years ago

I wrote a terminal graphics library! It might be interesting to use something like this to be able to embed graphics into terminal-based presentations:

https://github.com/dheera/python-termgraphics

vortex_ape20• 6 years ago

Termgraphics looks awesome, I'll try it out this week!

wodenokoto• 6 years ago

During this years juliacon there was an absolutely amazing termnial based presentation on building terminal based UI's:

https://www.youtube.com/watch?v=-TASx67pphw

vortex_ape20• 6 years ago

Thanks for posting, this is such a cool and informative talk! I love the typewriter animation :D

amasad• 6 years ago

Very cool. Runs on repl.it nicely: https://repl.it/@amasad/terminal-present

vortex_ape20• 6 years ago

Thanks for adding the repl.it badge!

mbo• 6 years ago

There's a major missed opportunity here - you can create codeblocks but there's no way to _run_ the codeblocks.

https://github.com/marconilanna/REPLesent, a similar tool for Scala, supports this by pressing `r` on any slide - all code will be evaluated into the REPL.

geek_at• 6 years ago

Also imagine they'd combine their codebase with shellshare (live streaming shell)

https://shellshare.net/

mrshu• 6 years ago

There is also patat (https://github.com/jaspervdj/patat) that does a similar thing.

It does not have effects, but it can do colors and has many other features one would expect from a presentation tool. It has also been around for a while, it is rather stable and written in Haskell. Many Linux distributions already have it in their repositories (https://github.com/jaspervdj/patat#installation).

Worth trying out as well!

A terminal-based presentation tool with colors and effects

Related Stories