Metadata-Version: 2.1
Name: terminhtml
Version: 0.9.2
Summary: Run shell commands and convert into an HTML/CSS animated terminal
Home-page: https://github.com/nickderobertis/terminhtml
Author: Nick DeRobertis
Author-email: derobertis.nick@gmail.com
License: MIT
Project-URL: Code, https://github.com/nickderobertis/terminhtml
Project-URL: Documentation, https://nickderobertis.github.io/terminhtml
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

[![](https://codecov.io/gh/nickderobertis/terminhtml/branch/main/graph/badge.svg)](https://codecov.io/gh/nickderobertis/terminhtml)
[![PyPI](https://img.shields.io/pypi/v/terminhtml)](https://pypi.org/project/terminhtml/)
![PyPI - License](https://img.shields.io/pypi/l/terminhtml)
[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/terminhtml/)
[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/terminhtml/)

#  TerminHTML

<div align="center">
  <p align="center">
    <a href="https://nickderobertis.github.io/terminhtml/">
      <img src="https://nickderobertis.github.io/terminhtml/_static/images/demo-output.gif" alt="TerminHTML example GIF">
    </a>
  </p>
  <sub>This GIF doesn't do TerminHTML justice, check out the full version <a href="https://nickderobertis.github.io/terminhtml/">in the docs</a></sub>
</div>

## Overview

Run shell commands and convert into an HTML/CSS animated terminal

## Getting Started

Install `terminhtml`. Recommended installation is with 
[pipx](https://github.com/pypa/pipx) but can also be done via `pip`:

```
pipx install terminhtml
```

A simple example:

```shell
terminhtml "echo 'Hello World'"
```

See 
[more examples in the documentation.](
https://nickderobertis.github.io/terminhtml/
)

## 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.

## Author

Created by Nick DeRobertis. MIT License.

## Related Projects

- [terminhtml-js](https://github.com/nickderobertis/terminhtml-js) - The JavaScript frontend for TerminHTML, but can also be used standalone
- [terminhtml-bootstrap](https://github.com/nickderobertis/terminhtml-bootstrap) - A script that loads TerminHTML in the browser with default settings
- [sphinx-terminhtml](https://nickderobertis.github.io/sphinx-terminhtml/) - A Sphinx directive for using TerminHTML in Sphinx projects

## Links

See the
[documentation here.](
https://nickderobertis.github.io/terminhtml/
)


