ansitoimg 2024.2

Description:

ansitoimg 2024.2

AnsiToImg

Convert an ANSI string to an image. Great for adding terminal output into a readme.

Example Output
Documentation
Install With PIP
Language information

Built for


Install Python on Windows

Chocolatey
Windows - Python.org


Install Python on Linux

Apt
Dnf


Install Python on MacOS

Homebrew
MacOS - Python.org


How to run

Windows
Linux/ MacOS


Building
Testing
Download Project

Clone

Using The Command Line
Using GitHub Desktop


Download Zip File


Community Files

Licence
Changelog
Code of Conduct
Contributing
Security
Support
Rationale



Example Output

Documentation
A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:

Tutorials take you by the hand through a series of steps to get
started using the software. Start here if you’re new.
The Technical Reference documents APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.


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 versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11
Install Python on Windows
Chocolatey
choco install python

Windows - Python.org
To install Python, go to https://www.python.org/downloads/windows/ and download the latest
version.
Install Python on Linux
Apt
sudo apt install python3.x

Dnf
sudo dnf install python3.x

Install Python on MacOS
Homebrew
brew install [email protected]

MacOS - Python.org
To install Python, go to https://www.python.org/downloads/macos/ and download the latest
version.
How to run
Windows


Module
py -3.x -m [module] or [module] (if module installs a script)


File
py -3.x [file] or ./[file]


Linux/ MacOS


Module
python3.x -m [module] or [module] (if module installs a script)


File
python3.x [file] or ./[file]


Building
This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefacts
Note the functionality provided by fhmake can be approximated by the following
handsdown --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit can be run to perform additional checks
Testing
For testing with the version of python used by poetry use
poetry run pytest

Alternatively use tox to run tests over python 3.8 - 3.11
tox

Download Project
Clone
Using The Command Line

Press the Clone or download button in the top right
Copy the URL (link)
Open the command line and change directory to where you wish to
clone to
Type 'git clone' followed by URL in step 2
git clone https://github.com/FHPythonUtils/AnsiToImg



More information can be found at
https://help.github.com/en/articles/cloning-a-repository
Using GitHub Desktop

Press the Clone or download button in the top right
Click open in desktop
Choose the path for where you want and click Clone

More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
Download Zip File

Download this GitHub repository
Extract the zip archive
Copy/ move to the desired location

Community Files
Licence
MIT License
Copyright (c) FredHappyface
(See the LICENSE for more information.)
Changelog
See the Changelog for more information.
Code of Conduct
Online communities include people from many backgrounds. The Project
contributors are committed to providing a friendly, safe and welcoming
environment for all. 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.
Rationale
The rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see the
Rationale
for more information.