TerminHTML
This GIF doesn't do TerminHTML justice, check out the full version in the docs
Overview
Run shell commands and convert into an HTML/CSS animated terminal
Getting Started
Install terminhtml
. Recommended installation is with
pipx but can also be done via pip
:
pipx install terminhtml
A simple example:
terminhtml "echo 'Hello World'"
See
more examples in the documentation.
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
.
Author
Created by Nick DeRobertis. MIT License.
Related Projects
- terminhtml-js - The JavaScript frontend for TerminHTML, but can also be used standalone
- terminhtml-bootstrap - A script that loads TerminHTML in the browser with default settings
- sphinx-terminhtml - A Sphinx directive for using TerminHTML in Sphinx projects
Links
See the
documentation here.