Welcome to TerminHTML Recorder documentation!¶
terminhtml-recorder¶
Overview¶
Create video and image files via TerminHTML rather than HTML/CSS/JS
Getting Started¶
Install terminhtml-recorder
:
pip install terminhtml-recorder
A simple example:
import terminhtml_recorder
# Do something with terminhtml_recorder
Development Status¶
This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.
Developing¶
First ensure that you have pipx
installed, if not, install it with pip install pipx
.
Then clone the repo and run npm install
and pipenv sync
. Run pipenv shell
to use the virtual environment. Make your changes and then run nox
to run formatting,
linting, and tests.
Develop documentation by running nox -s docs
to start up a dev server.
To run tests only, run nox -s test
. You can pass additional arguments to pytest
by adding them after --
, e.g. nox -s test -- -k test_something
.
Links¶
See the documentation here.
For more information on getting started, take a look at the tutorial and examples.