Convert an ansi string to an image. Great for adding terminal output into a readme.
Project description
AnsiToImg
Convert an ansi string to an image. Great for adding terminal output into a readme.
- Examples
- Choosing ansiToSVG or ansiToRaster
- Roadmap
- Changelog
- Install With PIP
- Language information
- Install Python on Windows
- Install Python on Linux
- How to run
- How to update, build and publish
- Community Files
Examples
Here is an example of some code and the images it produces:
import sys
import os
from pathlib import Path
import platform
import ctypes
from catimage.catimage import generateHDColour
THISDIR = str(Path(__file__).resolve().parent)
sys.path.insert(0, os.path.dirname(THISDIR))
from ansitoimg.txtrender import ansiToSVG, ansiToRaster
if platform.system() == "Windows":
kernel32 = ctypes.windll.kernel32
kernel32.SetConsoleMode(kernel32.GetStdHandle(-11), 7)
example = "👋\033[32mHello\033[0m, \033[34mWorld\033[0m🌏\033[31m!\033[0m\n\033[41m👋\033[0m\033[43m🦄\033[0m\033[42m🐘\033[0m\033[3m\033[9m13\033[0m\033[1m3\033[0m\033[4m7\033[0m\033[46m🍄\033[0m\033[44m🎃\033[0m\033[45m🐦\033[0m"
ansiToSVG(example, THISDIR + "/example.svg")
ansiToRaster(example, THISDIR + "/example.png")
example2 = "hello\nworld\n\033[42m\033[31mwe meet again\033[0m\nABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz😁😂🤣😃😄😅😆😉😊😋😎😍😘🥰😗😙😚☺🙂🤗🤩🤔🤨😐😑😶🙄😏😣😥😮🤐😯😪asdfghjk"
ansiToSVG(example2, THISDIR + "/example2.svg")
ansiToRaster(example, THISDIR + "/example.png")
example3 = generateHDColour(THISDIR + "/test.png", 40)
ansiToSVG(example3, THISDIR + "/example3.svg")
ansiToRaster(example, THISDIR + "/example.png")
SVG Image
Raster Image
Choosing ansiToSVG or ansiToRaster
ansiToSVG
This is better for the vast majority of cases as the image sizes are smaller
for reasonably simple ansi sequences. The image size scales proportionally
with the length of the ansi sequence. A large number of applications tend to
opt for shorter sequences for output making ansiToSVG
the better option.
ansiToSVG
also handles emoji as well as the OS does. For instance, on Windows
10 one can expect full colour emoji. Image sizes can get out of hand for some
cases such as catimage output as those tend to be very long ansi sequences.
ansiToSVG
The image size does not scale to the length of the ansi sequence but does scale
to the number of lines of terminal output. This is ideal for output of complex
ansi sequences that would be huge if ansiToSVG
were used. However, emojis are
in black and white and show quite poorly on coloured backgrounds.
Windows Terminal
Roadmap
Add option to convert to raster images through pillow
Changelog
See the CHANGELOG for more information.
Install With PIP
pip install ansitoimg
Head to https://pypi.org/project/ansitoimg/ for more info
Language information
Built for
This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.
Install Python on Windows
Chocolatey
choco install python
Download
To install Python, go to https://www.python.org/ and download the latest version.
Install Python on Linux
Apt
sudo apt install python3.8
How to run
With VSCode
- Open the .py file in vscode
- Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
- Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
From the Terminal
./[file].py
How to update, build and publish
- Ensure you have installed the following dependencies
Linux
wget dephell.org/install | python3.8 wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
Windows(wget dephell.org/install -UseBasicParsing).Content | python (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
- Use poetry for the heavy lifting and dephell to generate requirements
poetry update dephell deps convert
- Build/ Publish
poetry build poetry publish
orpoetry publish --build
Community Files
Licence
MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)
Changelog
See the Changelog for more information.
Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.
Contributing
Contributions are welcome, please see the Contributing Guidelines for more information.
Security
Thank you for improving the security of the project, please see the Security Policy for more information.
Support
Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ansitoimg-2020.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c9e1abecb6be4a2dde1484a3ca6c2cb11885d50cba6ca069b958b5d9421b78a |
|
MD5 | 6953108f714c0ecfdb84cce958e2e18d |
|
BLAKE2b-256 | 0d49b185d1c22e916f69897ebfb636bc155acee2737d6793cceeb16210fab257 |