diff options
Diffstat (limited to 'python-ansitoimg.spec')
| -rw-r--r-- | python-ansitoimg.spec | 829 |
1 files changed, 829 insertions, 0 deletions
diff --git a/python-ansitoimg.spec b/python-ansitoimg.spec new file mode 100644 index 0000000..3df6a19 --- /dev/null +++ b/python-ansitoimg.spec @@ -0,0 +1,829 @@ +%global _empty_manifest_terminate_build 0 +Name: python-ansitoimg +Version: 2023.1 +Release: 1 +Summary: Convert an ANSI string to an image. Great for adding terminal output into a readme. +License: MIT +URL: https://github.com/FHPythonUtils/AnsiToImg +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/d2/3c/2b803eeeeddeceabbc25bb11e6fcf34c65a3ff3a991b490546e870a40a6e/ansitoimg-2023.1.tar.gz +BuildArch: noarch + +Requires: python3-PyYAML +Requires: python3-rich +Requires: python3-install-playwright +Requires: python3-playwright + +%description +[](../../) +[](../../) +[](../../issues) +[](/LICENSE.md) +[](../../commits/master) +[](../../commits/master) +[](https://pypistats.org/packages/ansitoimg) +[](https://pepy.tech/project/AnsiToImg) +[](https://pypi.org/project/AnsiToImg) + +<!-- omit in toc --> +# AnsiToImg + +<img src="readme-assets/icons/name.png" alt="Project Icon" width="750"> + +Convert an ANSI string to an image. Great for adding terminal output into a readme. + +- [Example Output](#example-output) +- [Documentation](#documentation) +- [Install With PIP](#install-with-pip) +- [Language information](#language-information) + - [Built for](#built-for) +- [Install Python on Windows](#install-python-on-windows) + - [Chocolatey](#chocolatey) + - [Windows - Python.org](#windows---pythonorg) +- [Install Python on Linux](#install-python-on-linux) + - [Apt](#apt) + - [Dnf](#dnf) +- [Install Python on MacOS](#install-python-on-macos) + - [Homebrew](#homebrew) + - [MacOS - Python.org](#macos---pythonorg) +- [How to run](#how-to-run) + - [Windows](#windows) + - [Linux/ MacOS](#linux-macos) +- [Building](#building) +- [Testing](#testing) +- [Download Project](#download-project) + - [Clone](#clone) + - [Using The Command Line](#using-the-command-line) + - [Using GitHub Desktop](#using-github-desktop) + - [Download Zip File](#download-zip-file) +- [Community Files](#community-files) + - [Licence](#licence) + - [Changelog](#changelog) + - [Code of Conduct](#code-of-conduct) + - [Contributing](#contributing) + - [Security](#security) + - [Support](#support) + - [Rationale](#rationale) + +## Example Output + +<img src="readme-assets/terminal.png" alt="winterm" width="450"> + +## Documentation + +A high-level overview of how the documentation is organized organized will help you know +where to look for certain things: + +- [Tutorials](/documentation/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](/documentation/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](/documentation/help) guide provides a starting point and outlines common issues that you + may have. +--> + +## Install With PIP + +```python +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 + +```powershell +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 + +```bash +sudo apt install python3.x +``` + +### Dnf + +```bash +sudo dnf install python3.x +``` + +## Install Python on MacOS + +### Homebrew + +```bash +brew install python@3.x +``` + +### 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 + +```sh +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 + +```sh +poetry run pytest +``` + +Alternatively use `tox` to run tests over python 3.8 - 3.11 + +```sh +tox +``` + +## Download Project + +### Clone + +#### Using The Command Line + +1. Press the Clone or download button in the top right +2. Copy the URL (link) +3. Open the command line and change directory to where you wish to +clone to +4. Type 'git clone' followed by URL in step 2 + ```bash + 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 + +1. Press the Clone or download button in the top right +2. Click open in desktop +3. 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 + +1. Download this GitHub repository +2. Extract the zip archive +3. Copy/ move to the desired location + +## Community Files + +### Licence + +MIT License +Copyright (c) FredHappyface +(See the [LICENSE](/LICENSE.md) for more information.) + +### Changelog + +See the [Changelog](/CHANGELOG.md) 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](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md) + for more information. + +### Contributing + +Contributions are welcome, please see the +[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md) +for more information. + +### Security + +Thank you for improving the security of the project, please see the +[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md) +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](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md) +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](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md) +for more information. + + +%package -n python3-ansitoimg +Summary: Convert an ANSI string to an image. Great for adding terminal output into a readme. +Provides: python-ansitoimg +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-ansitoimg +[](../../) +[](../../) +[](../../issues) +[](/LICENSE.md) +[](../../commits/master) +[](../../commits/master) +[](https://pypistats.org/packages/ansitoimg) +[](https://pepy.tech/project/AnsiToImg) +[](https://pypi.org/project/AnsiToImg) + +<!-- omit in toc --> +# AnsiToImg + +<img src="readme-assets/icons/name.png" alt="Project Icon" width="750"> + +Convert an ANSI string to an image. Great for adding terminal output into a readme. + +- [Example Output](#example-output) +- [Documentation](#documentation) +- [Install With PIP](#install-with-pip) +- [Language information](#language-information) + - [Built for](#built-for) +- [Install Python on Windows](#install-python-on-windows) + - [Chocolatey](#chocolatey) + - [Windows - Python.org](#windows---pythonorg) +- [Install Python on Linux](#install-python-on-linux) + - [Apt](#apt) + - [Dnf](#dnf) +- [Install Python on MacOS](#install-python-on-macos) + - [Homebrew](#homebrew) + - [MacOS - Python.org](#macos---pythonorg) +- [How to run](#how-to-run) + - [Windows](#windows) + - [Linux/ MacOS](#linux-macos) +- [Building](#building) +- [Testing](#testing) +- [Download Project](#download-project) + - [Clone](#clone) + - [Using The Command Line](#using-the-command-line) + - [Using GitHub Desktop](#using-github-desktop) + - [Download Zip File](#download-zip-file) +- [Community Files](#community-files) + - [Licence](#licence) + - [Changelog](#changelog) + - [Code of Conduct](#code-of-conduct) + - [Contributing](#contributing) + - [Security](#security) + - [Support](#support) + - [Rationale](#rationale) + +## Example Output + +<img src="readme-assets/terminal.png" alt="winterm" width="450"> + +## Documentation + +A high-level overview of how the documentation is organized organized will help you know +where to look for certain things: + +- [Tutorials](/documentation/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](/documentation/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](/documentation/help) guide provides a starting point and outlines common issues that you + may have. +--> + +## Install With PIP + +```python +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 + +```powershell +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 + +```bash +sudo apt install python3.x +``` + +### Dnf + +```bash +sudo dnf install python3.x +``` + +## Install Python on MacOS + +### Homebrew + +```bash +brew install python@3.x +``` + +### 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 + +```sh +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 + +```sh +poetry run pytest +``` + +Alternatively use `tox` to run tests over python 3.8 - 3.11 + +```sh +tox +``` + +## Download Project + +### Clone + +#### Using The Command Line + +1. Press the Clone or download button in the top right +2. Copy the URL (link) +3. Open the command line and change directory to where you wish to +clone to +4. Type 'git clone' followed by URL in step 2 + ```bash + 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 + +1. Press the Clone or download button in the top right +2. Click open in desktop +3. 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 + +1. Download this GitHub repository +2. Extract the zip archive +3. Copy/ move to the desired location + +## Community Files + +### Licence + +MIT License +Copyright (c) FredHappyface +(See the [LICENSE](/LICENSE.md) for more information.) + +### Changelog + +See the [Changelog](/CHANGELOG.md) 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](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md) + for more information. + +### Contributing + +Contributions are welcome, please see the +[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md) +for more information. + +### Security + +Thank you for improving the security of the project, please see the +[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md) +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](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md) +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](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md) +for more information. + + +%package help +Summary: Development documents and examples for ansitoimg +Provides: python3-ansitoimg-doc +%description help +[](../../) +[](../../) +[](../../issues) +[](/LICENSE.md) +[](../../commits/master) +[](../../commits/master) +[](https://pypistats.org/packages/ansitoimg) +[](https://pepy.tech/project/AnsiToImg) +[](https://pypi.org/project/AnsiToImg) + +<!-- omit in toc --> +# AnsiToImg + +<img src="readme-assets/icons/name.png" alt="Project Icon" width="750"> + +Convert an ANSI string to an image. Great for adding terminal output into a readme. + +- [Example Output](#example-output) +- [Documentation](#documentation) +- [Install With PIP](#install-with-pip) +- [Language information](#language-information) + - [Built for](#built-for) +- [Install Python on Windows](#install-python-on-windows) + - [Chocolatey](#chocolatey) + - [Windows - Python.org](#windows---pythonorg) +- [Install Python on Linux](#install-python-on-linux) + - [Apt](#apt) + - [Dnf](#dnf) +- [Install Python on MacOS](#install-python-on-macos) + - [Homebrew](#homebrew) + - [MacOS - Python.org](#macos---pythonorg) +- [How to run](#how-to-run) + - [Windows](#windows) + - [Linux/ MacOS](#linux-macos) +- [Building](#building) +- [Testing](#testing) +- [Download Project](#download-project) + - [Clone](#clone) + - [Using The Command Line](#using-the-command-line) + - [Using GitHub Desktop](#using-github-desktop) + - [Download Zip File](#download-zip-file) +- [Community Files](#community-files) + - [Licence](#licence) + - [Changelog](#changelog) + - [Code of Conduct](#code-of-conduct) + - [Contributing](#contributing) + - [Security](#security) + - [Support](#support) + - [Rationale](#rationale) + +## Example Output + +<img src="readme-assets/terminal.png" alt="winterm" width="450"> + +## Documentation + +A high-level overview of how the documentation is organized organized will help you know +where to look for certain things: + +- [Tutorials](/documentation/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](/documentation/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](/documentation/help) guide provides a starting point and outlines common issues that you + may have. +--> + +## Install With PIP + +```python +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 + +```powershell +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 + +```bash +sudo apt install python3.x +``` + +### Dnf + +```bash +sudo dnf install python3.x +``` + +## Install Python on MacOS + +### Homebrew + +```bash +brew install python@3.x +``` + +### 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 + +```sh +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 + +```sh +poetry run pytest +``` + +Alternatively use `tox` to run tests over python 3.8 - 3.11 + +```sh +tox +``` + +## Download Project + +### Clone + +#### Using The Command Line + +1. Press the Clone or download button in the top right +2. Copy the URL (link) +3. Open the command line and change directory to where you wish to +clone to +4. Type 'git clone' followed by URL in step 2 + ```bash + 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 + +1. Press the Clone or download button in the top right +2. Click open in desktop +3. 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 + +1. Download this GitHub repository +2. Extract the zip archive +3. Copy/ move to the desired location + +## Community Files + +### Licence + +MIT License +Copyright (c) FredHappyface +(See the [LICENSE](/LICENSE.md) for more information.) + +### Changelog + +See the [Changelog](/CHANGELOG.md) 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](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md) + for more information. + +### Contributing + +Contributions are welcome, please see the +[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md) +for more information. + +### Security + +Thank you for improving the security of the project, please see the +[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md) +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](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md) +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](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md) +for more information. + + +%prep +%autosetup -n ansitoimg-2023.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-ansitoimg -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 29 2023 Python_Bot <Python_Bot@openeuler.org> - 2023.1-1 +- Package Spec generated |