Convert an ANSI string to an image. Great for adding terminal output into a readme.
- Example Output
- Documentation
- Install With PIP
- Language information
- Install Python on Windows
- Install Python on Linux
- Install Python on MacOS
- How to run
- Building
- Testing
- Download Project
- Community Files
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.
- The Help guide provides a starting point and outlines common issues that you may have.
pip install ansitoimgHead to https://pypi.org/project/ansitoimg/ for more info
This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and 3.11
choco install pythonTo install Python, go to https://www.python.org/downloads/windows/ and download the latest version.
sudo apt install python3.xsudo dnf install python3.xbrew install python@3.xTo install Python, go to https://www.python.org/downloads/macos/ and download the latest version.
-
Module
py -3.x -m [module]or[module](if module installs a script) -
File
py -3.x [file]or./[file]
-
Module
python3.x -m [module]or[module](if module installs a script) -
File
python3.x [file]or./[file]
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 buildfhmake audit can be run to perform additional checks
For testing with the version of python used by poetry use
poetry run pytestAlternatively use tox to run tests over python 3.8 - 3.11
tox- 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
- 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 this GitHub repository
- Extract the zip archive
- Copy/ move to the desired location
MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)
See the Changelog for more information.
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.
Contributions are welcome, please see the Contributing Guidelines for more information.
Thank you for improving the security of the project, please see the Security Policy for more information.
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.
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.