custom `capture` may diverge from upstream

Asciicast

Asciicast.jl is all about showcasing Julia code running in a REPL using technologies developed by the open-source asciinema project. (It is totally unaffiliated with the authors of that project, however).

It does so in a few ways:

provides a convenient way to generate and maintain gifs showing code execution in READMEs and other documents. See the Markdown Usage portion of the docs.
provides integration with Documenter, providing @cast Documenter blocks that render code outputs as gifs in Documenter websites. See the Documenter Usage portion of the docs.
provides functionality to generate asciicast files (using the v2 file format) from Julia code, using the cast"" string macro, a record_output function, or using low-level write_event commands. These files can be played in the terminal or uploaded to asciinema.org with the asciinema player, or played in a web browser using asciinema-player. See the docs for more.

Demo:

@info "Hello!"
println("That was a logging statement, but this is printing.")
x = rand(10, 10)
using LinearAlgebra
svd(x)
println("Now I'll wait a second")
sleep(1)
println("ok, done!")

Alternatives to Asciicast.jl

It is easy to use the CLI tool asciinema directly to record sessions to .cast files or otherwise. That can be a good option if you need keyboard input or face some of the other Limitations of asciicast.jl.
- In contrast, Asciicast.jl has an advantage in maintainability, in that you don't need to manually re-run sessions to regenerate the outputs.
Replay.jl provides a similar Julia-based alternative. Some of the differences I can ascertain:
- Asciicast.jl is based on Documenter's code execution sandboxes (which have their limitations), while Replay.jl has it's own implementation.
- Asciicast.jl provides Documenter and pandoc-based document integration with @cast blocks and {cast="true"} blocks, while Replay seems focused on the core replaying-of-sessions. Perhaps these could be composed together somehow?
- Possibly other differences; I am not very familiar with Replay.jl. PRs to improve this comparison are appreciated!

	# Very hacky fix to load the asciinema JS before Documenter's require.js
	# <https://github.com/JuliaDocs/Documenter.jl/issues/1433>
	requires_regex = r"""<script src="https://cdnjs\.cloudflare\.com/ajax/libs/require\.js/[0-9]+\.[0-9]+\.[0-9]+/require\.min\.js" data-main="assets/documenter\.js"></script>"""
	asciinema_script = """<script src="https://cdnjs.cloudflare.com/ajax/libs/asciinema-player/$(asciinema_version)/asciinema-player.min.js"></script>"""
	index_path = joinpath(@__DIR__, "build", "index.html")
	index = read(index_path, String)
	requires_script = match(requires_regex, index).match # get the right version numbers for requires.js
	index = replace(index, asciinema_script => "")
	index = replace(index, requires_script => asciinema_script*requires_script)
	write(index_path, index)

ericphanson / asciicast.jl Goto Github PK

asciicast.jl's Introduction

Asciicast

Alternatives to Asciicast.jl

asciicast.jl's People

Contributors

Stargazers

Watchers

asciicast.jl's Issues

Recommend Projects

Recommend Topics

Recommend Org