https://github.com/abilian/asciicast

Easily create terminal screencast. Based on asciinema.
https://github.com/abilian/asciicast

Last synced: 9 days ago
JSON representation

Easily create terminal screencast. Based on asciinema.

• Host: GitHub
• URL: https://github.com/abilian/asciicast
• Owner: abilian
• License: mit
• Created: 2023-04-02T16:43:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-22T13:09:50.000Z (5 months ago)
• Last Synced: 2024-11-21T03:32:06.386Z (22 days ago)
• Language: Python
• Size: 20.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• jimsghstars - abilian/asciicast - Easily create terminal screencast. Based on asciinema. (Python)

README

        
# Asciicast: generate asciicasts from Python code

[![image](https://img.shields.io/pypi/v/asciicast.svg)](https://pypi.python.org/pypi/asciicast)

[![image](https://img.shields.io/travis/sfermigier/asciicast.svg)](https://travis-ci.com/sfermigier/asciicast)

[![Documentation Status](https://readthedocs.org/projects/asciicast/badge/?version=latest)](https://asciicast.readthedocs.io/en/latest/?version=latest)

This package provides a Python API to generate

[asciicasts](https://asciinema.org/docs/asciicast-v2) from Python code.

## Installation

```bash

    pip install asciicast

```

## Demo

[![asciicast](https://asciinema.org/a/wlIj0hTLZVWnjGdIsiB730KT2.svg)](https://asciinema.org/a/wlIj0hTLZVWnjGdIsiB730KT2)

## Usage

The `asciicast` module provides a `Asciicast` class that can be used to record

asciicasts from Python code.

Example:

```python

from asciicast.cast import Cast

cast = Cast(typing_delay=0.03)

cast.echo("# How to use asciicast?")

cast.wait(0.5)

cast.type("cat -n examples/demo1.py")

cast.wait(0.2)

cast.run()

```