| Name | termynal JSON |
| Version |
0.12.2
JSON |
| download |
| home_page | None |
| Summary | A lightweight and modern animated terminal window |
| upload_time | 2024-11-09 14:15:36 |
| maintainer | None |
| docs_url | None |
| author | Danil Akhtarov |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Danil Akhtarov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
markdown
mkdocs
plugin
termynal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Termynal
[](https://pypi.org/project/termynal/)
[](https://www.python.org/downloads/)
[](https://termynal.github.io/termynal.py/)
A lightweight and modern animated terminal window.
Built for [mkdocs](https://www.mkdocs.org/).
## Installation
[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": null,
"name": "termynal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "markdown, mkdocs, plugin, termynal",
"author": "Danil Akhtarov",
"author_email": "daxartio@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/64/2b/a0fae74a6e14f72a651e53a92c81a1edf8871a9d1de488b4814773872dce/termynal-0.12.2.tar.gz",
"platform": null,
"description": "# Termynal\n\n\n[](https://pypi.org/project/termynal/)\n[](https://www.python.org/downloads/)\n[](https://termynal.github.io/termynal.py/)\n\n\n\n\nA lightweight and modern animated terminal window.\nBuilt for [mkdocs](https://www.mkdocs.org/).\n\n## Installation\n\n\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 License Copyright (c) 2024 Danil Akhtarov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A lightweight and modern animated terminal window",
"version": "0.12.2",
"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": [
"markdown",
" mkdocs",
" plugin",
" termynal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bca08cbeec411f2dbcf94931c9488f6a8383ebe63e39ac62d0cdc6827bcd791a",
"md5": "7f873e5681746d3e17a7af1a247ae390",
"sha256": "62314dac6e77f1b7b64a251c2c90702eb6e6910f72ea9c6e5ef68d715b272709"
},
"downloads": -1,
"filename": "termynal-0.12.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f873e5681746d3e17a7af1a247ae390",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10751,
"upload_time": "2024-11-09T14:15:35",
"upload_time_iso_8601": "2024-11-09T14:15:35.262275Z",
"url": "https://files.pythonhosted.org/packages/bc/a0/8cbeec411f2dbcf94931c9488f6a8383ebe63e39ac62d0cdc6827bcd791a/termynal-0.12.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "642ba0fae74a6e14f72a651e53a92c81a1edf8871a9d1de488b4814773872dce",
"md5": "5c89bd2402bedce8e3e434d5036c3540",
"sha256": "cc2356bbf8650c16abd0558786251fabdde6b25e1125c1f091607ed3e422f7f2"
},
"downloads": -1,
"filename": "termynal-0.12.2.tar.gz",
"has_sig": false,
"md5_digest": "5c89bd2402bedce8e3e434d5036c3540",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 173890,
"upload_time": "2024-11-09T14:15:36",
"upload_time_iso_8601": "2024-11-09T14:15:36.908923Z",
"url": "https://files.pythonhosted.org/packages/64/2b/a0fae74a6e14f72a651e53a92c81a1edf8871a9d1de488b4814773872dce/termynal-0.12.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 14:15:36",
"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"
}
