Terminal based code snippet display tool
Project description
During talks or screencasts I don’t want to be typing code, it is too error prone and too likely to mess up my speaking flow. Purdy is both a set of programs and a library to display colourized code in a series of animations.
The purdy command takes one of a Python program, a Python REPL console file or a Bash console file. Source code is presented to the screen as if typing. For console files, the typing pauses at a prompt, waiting for interaction. Prompts are:
>>> or ... for Python REPL
$ for Bash console
If the program is paused at a prompt, pressing the right arrow will continue. Typing animation can be skipped over by pressing the letter “s” instead. Animation can be undone by pressing the left arrow.
Example Usage:
$ purdy code-snippet.py
The result looks like this:
Once the code has been displayed, further key presses are ignored. At any time you can press “q” to quit.
Purdy Programs
The following programs come with the purdy library:
purdy – Animated display that looks like a program is being typed to the screen.
pat – “purdy cat”, prints ANSI colourized source.
prat – “purdy RTF cat”, prints colourized source in RTF document format. Particularly useful for copying to a clipboard and pasting full colourized source into a document. On OS X prat <filename> | pbcopy will put the output directly to the clipboard.
subpurdy – Full set of commands to control Purdy. Sub-commands dictate behaviour. Does a variety of code presentation. Includes ANSI, RTF, HTML output as well as the typewriter animations.
More information can be found in the Command Line Program Documentation.
Purdy Library
The purdy script is fairly simple. You can create more complex animations by writing programs using the purdy library. Custom programs can have split screens, highlighting lines, slide transitions and more. More information can be found in the Library Documentation.
Installation
$ pip install purdy
Supports
Purdy has been tested with Python 3.7. Terminal control is done with the Urwid library. Parsing and tokenization is done through Pygments. Both libraries are execellent and I’m grateful they’re publically available.
Docs & Source
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for purdy-1.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42ed9bbb95e9014965e84b1bee5202d2704947bf150ce03d58e7cf9a7882544c |
|
MD5 | 0bdfbaa0bbee5409e8cd70872606a022 |
|
BLAKE2b-256 | 7b21d0750972dbfe6a21e8c5289fc5df62d30f48b8834f157bc91b2335a2db90 |