Skip to main content

asciinema-automation

https://badge.fury.io/py/asciinema-automation.svg https://github.com/PierreMarchand20/asciinema_automation/actions/workflows/CI.yml/badge.svg

asciinema-automation is a Python package which provides a small CLI utility to automate asciinema recordings. The only dependencies are asciinema and Pexpect.

Recording is made easier by:

  • making the live recording for you, to get the perfect take in one go (no more missed keys!),

  • while looking not too robotic by adding Gaussian delay between keystrokes.

One specificity of this package is that

  • it makes automated recording as reproducible and robust as possible. In particular, there is no need to add a manually set waiting time between commands to wait for previous outputs.

To that end, you can write the commands you wish to showcase in a text file, and using comment lines starting by #$ (see examples folder and example), you can specify the expected output of each command, and/or change the configuration of the automated recording on-the-fly.

Example

Demo

This example is generated reading with asciinema-automation a script that calls asciinema-automation which reads the hello_world.sh example in this repository 🙃

Numerous examples can also be found here.

Installation

You can use pip to install:

python3 -m pip install asciinema-automation

Or you can install it directly using this GitHub repository. In this case, you need to call git clone to recover the source code of this repository

git clone https://github.com/PierreMarchand20/asciinema_automation.git

and then call pip in your local folder of this repository to install this package and its dependencies

pip3 install .

History

This repository is inspired by asciiscript, which is not maintained any more. I first made a fork, but being not very familiar with go, I preferred to rewrite everything in python.

Metadata

Release files for asciinema-automation 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for asciinema-automation 0.2.2
File Size Uploaded Provenance Actions
asciinema_automation-0.2.2.tar.gz 7.9 kB Without provenance Details for asciinema_automation-0.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for asciinema-automation 0.2.2
File Interpreter ABI Platform Actions
asciinema_automation-0.2.2-py3-none-any.whl Python 3 none any Details for asciinema_automation-0.2.2-py3-none-any.whl

Total release size: 16.0 kB

Release files / asciinema_automation-0.2.2.tar.gz

Download URL asciinema_automation-0.2.2.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3c6e7587bafe6c23881dbc48693f87df54ce2204794e555fd94725337ddf0279
BLAKE2b-256 checksum
How to use checksums
a98af36f8c1c7e6ae4979cc27c49887afc72fad33d9be4ac7fd4105b91b51977
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / asciinema_automation-0.2.2-py3-none-any.whl

Download URL asciinema_automation-0.2.2-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d4f7c776728e1a9edd7663ffa882c71ba07ce020455f851049be4c747fd4d83
BLAKE2b-256 checksum
How to use checksums
d09a107fe12c27140769b67cd5d27e300c1b5ef7dfabd50f9683b7262ab1932f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for asciinema-automation 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page