termynal

Name	termynal JSON
Version	0.12.1 JSON
	download
home_page	https://termynal.github.io/termynal.py/
Summary	A lightweight and modern animated terminal window
upload_time	2024-02-18 14:38:59
maintainer
docs_url	None
author	Danil Akhtarov
requires_python	>=3.8.1,<4.0.0
license	MIT
keywords	mkdocs markdown plugin termynal
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Termynal

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/termynal/termynal.py/check.yml)
[![PyPI](https://img.shields.io/pypi/v/termynal)](https://pypi.org/project/termynal/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/termynal)](https://www.python.org/downloads/)
[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://termynal.github.io/termynal.py/)
![GitHub](https://img.shields.io/github/license/termynal/termynal.py)
![PyPI - Downloads](https://img.shields.io/pypi/dm/termynal)
![GitHub last commit](https://img.shields.io/github/last-commit/termynal/termynal.py)

A lightweight and modern animated terminal window.
Built for [mkdocs](https://www.mkdocs.org/).

## Installation

![termynal](termynal.gif)

[Examples](https://termynal.github.io/termynal.py/)

## Usage

Use `<!-- termynal -->` before code block

````
<!-- termynal -->

```
$ python script.py
```
````

### Mkdocs integration

Declare the plugin:

```yaml
...
plugins:
  - termynal
...
```

Optionally, pass options to the processor:

```yaml
[...]
plugins:
  - termynal:
      prompt_literal_start:
        - "$"
        - ">"
[...]
```

This config allows you to use another prompt:

````markdown
<!-- termynal -->

```
> pip install termynal
---> 100%
Installed
```

````

## Credits

Thanks [ines](https://github.com/ines/termynal)

## Contribution

[Contribution guidelines for this project](CONTRIBUTING.md)

            

Raw data

            {
    "_id": null,
    "home_page": "https://termynal.github.io/termynal.py/",
    "name": "termynal",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0.0",
    "maintainer_email": "",
    "keywords": "mkdocs,markdown,plugin,termynal",
    "author": "Danil Akhtarov",
    "author_email": "daxartio@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6a/cf/98fc8d1db9c1590da9b58179a8d180fa3046fb65fc35825ca29362500098/termynal-0.12.1.tar.gz",
    "platform": null,
    "description": "# Termynal\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/termynal/termynal.py/check.yml)\n[![PyPI](https://img.shields.io/pypi/v/termynal)](https://pypi.org/project/termynal/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/termynal)](https://www.python.org/downloads/)\n[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://termynal.github.io/termynal.py/)\n![GitHub](https://img.shields.io/github/license/termynal/termynal.py)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/termynal)\n![GitHub last commit](https://img.shields.io/github/last-commit/termynal/termynal.py)\n\nA lightweight and modern animated terminal window.\nBuilt for [mkdocs](https://www.mkdocs.org/).\n\n## Installation\n\n![termynal](termynal.gif)\n\n[Examples](https://termynal.github.io/termynal.py/)\n\n## Usage\n\nUse `<!-- termynal -->` before code block\n\n````\n<!-- termynal -->\n\n```\n$ python script.py\n```\n````\n\n### Mkdocs integration\n\nDeclare the plugin:\n\n```yaml\n...\nplugins:\n  - termynal\n...\n```\n\nOptionally, pass options to the processor:\n\n```yaml\n[...]\nplugins:\n  - termynal:\n      prompt_literal_start:\n        - \"$\"\n        - \">\"\n[...]\n```\n\nThis config allows you to use another prompt:\n\n````markdown\n<!-- termynal -->\n\n```\n> pip install termynal\n---> 100%\nInstalled\n```\n\n````\n\n## Credits\n\nThanks [ines](https://github.com/ines/termynal)\n\n## Contribution\n\n[Contribution guidelines for this project](CONTRIBUTING.md)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A lightweight and modern animated terminal window",
    "version": "0.12.1",
    "project_urls": {
        "Changelog": "https://termynal.github.io/termynal.py/changelog/",
        "Documentation": "https://termynal.github.io/termynal.py/",
        "Homepage": "https://termynal.github.io/termynal.py/",
        "Repository": "https://github.com/termynal/termynal.py"
    },
    "split_keywords": [
        "mkdocs",
        "markdown",
        "plugin",
        "termynal"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "935f00028bc6ed7ed5adea29b9ce0a52dd142e1defbdbf2266dfd150b18bb008",
                "md5": "5c98bce31e4295691b9bf5bc9c28a751",
                "sha256": "8420fc7ddc9daa5733c5aa370e7d2567a0e9299caa6e47fe8b5efd228fdffc47"
            },
            "downloads": -1,
            "filename": "termynal-0.12.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c98bce31e4295691b9bf5bc9c28a751",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 10175,
            "upload_time": "2024-02-18T14:38:57",
            "upload_time_iso_8601": "2024-02-18T14:38:57.250336Z",
            "url": "https://files.pythonhosted.org/packages/93/5f/00028bc6ed7ed5adea29b9ce0a52dd142e1defbdbf2266dfd150b18bb008/termynal-0.12.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6acf98fc8d1db9c1590da9b58179a8d180fa3046fb65fc35825ca29362500098",
                "md5": "e9c78f357b11675d059266baf8912724",
                "sha256": "48842b5066eee25d5efef570b776bbc7e2875fca547c38c39e73fec1bb562fa9"
            },
            "downloads": -1,
            "filename": "termynal-0.12.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e9c78f357b11675d059266baf8912724",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 9904,
            "upload_time": "2024-02-18T14:38:59",
            "upload_time_iso_8601": "2024-02-18T14:38:59.174433Z",
            "url": "https://files.pythonhosted.org/packages/6a/cf/98fc8d1db9c1590da9b58179a8d180fa3046fb65fc35825ca29362500098/termynal-0.12.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-18 14:38:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "termynal",
    "github_project": "termynal.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "termynal"
}