Metadata-Version: 2.1
Name: asciicast
Version: 0.1.1
Summary: Top-level package for asciicast.
Home-page: https://github.com/abilian/asciicast
Author: Abilian SAS
Author-email: sf@abilian.com
Requires-Python: >=3.10,<4
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: asciinema (>=2.2.0,<3.0.0)
Requires-Dist: attrs (>=23,<24)
Requires-Dist: click (>=8.1.3,<9.0.0)
Description-Content-Type: text/markdown

# 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()
```

