eRCaGuy-PyColors 0.1.0

A Python module to add ANSI color and format codes to strings for terminal output

eRCaGuy_PyColors

For text formatting and colorization in the terminal.

A Python module to add ANSI color and format codes to strings for terminal output.

Installation

Install from PyPI (once published):

pip install eRCaGuy_PyColors

Or install from source:

git clone https://github.com/ElectricRCAircraftGuy/eRCaGuy_PyColors.git
cd eRCaGuy_PyColors
pip install .

For development (editable install):

pip install -e .

To install into a virtual environment:

# Create and activate a virtual environment
python3 -m venv ~/venvs/eRCaGuy_PyColors
. ~/venvs/eRCaGuy_PyColors/bin/activate

# To see if you're in a virtual environment, run:
echo "$VIRTUAL_ENV"
# If in a virtual environment, this will print the path to the virtual environment.
# Otherwise, it will print nothing.

# Now install as above. Ex: 
# Option 1: install from PyPI:
pip install eRCaGuy_PyColors
# Option 2: install from source: 
# - Inside of the `eRCaGuy_PyColors` repo: 
pip install .

Example usage in your Python program

# Recommended import style
import eRCaGuy_PyColors as colors
# OR (older style): 
# import eRCaGuy_PyColors.ansi_colors as colors

print(f"{colors.FGR}This text is green.{colors.END}")
print(f"{colors.FBB}This text is bright blue.{colors.END}")
print(f"{colors.FBR}This text is bright red.{colors.END}")

colors.print_green("This text is green.")
colors.print_blue("This text is bright blue.")
colors.print_red("This text is bright red.")
colors.print_yellow("This text is bright yellow.")

Test and run this program

Run the built-in tests:

python3 -m eRCaGuy_PyColors

Example run and output:

eRCaGuy_PyColors$ ./ansi_colors.py 
This text is green.
This text is bright blue.
This text is bright red.
This text is bright red.
This text is bright red.
This text is bright red.
This text is
  bright red.
This text is bright yellow.
This text is not colored.
This text is bright yellow again.
This text is green.

Screenshot:

Publishing to PyPI

See:

1. https://packaging.python.org/en/latest/tutorials/packaging-projects/
2. https://packaging.python.org/en/latest/guides/writing-pyproject-toml/

For maintainers, to publish a new version to PyPI:

1. Install or upgrade twine:

   python3 -m pip install --upgrade twine build
   

2. Update the version number in eRCaGuy_PyColors/__init__.py.
3. Build the distribution packages according to the settings in pyproject.toml:

   time python3 -m build
   

4. Test an upload to TestPyPI first (recommended):

   python3 -m twine upload --repository testpypi dist/*
   

5. Test an installation in a virtual environment from TestPyPI:

   python3 -m venv ~/venvs/test_eRCaGuy_PyColors
   . ~/venvs/test_eRCaGuy_PyColors/bin/activate
   pip install --index-url https://test.pypi.org/simple/ --no-deps eRCaGuy_PyColors
   

   Test that it works as expected.
6. Upload to PyPI using twine:

   python3 -m twine upload dist/*
   

7. Test an installation in a virtual environment from PyPI:

   python3 -m venv ~/venvs/eRCaGuy_PyColors
   . ~/venvs/eRCaGuy_PyColors/bin/activate
   pip install eRCaGuy_PyColors
   

   Test that it works as expected.

References

1. Borrowed from my file here: https://github.com/ElectricRCAircraftGuy/eRCaGuy_hello_world/blob/master/python/pandas_dataframe_iteration_vs_vectorization_vs_list_comprehension_speed_tests.py
2. https://github.com/ElectricRCAircraftGuy/eRCaGuy_hello_world/blob/master/python/ansi_colors.py
3. https://github.com/ElectricRCAircraftGuy/eRCaGuy_PathShortener/blob/main/ansi_colors.py <==
4. My Bash ANSI format library here: https://github.com/ElectricRCAircraftGuy/eRCaGuy_hello_world/blob/master/bash/ansi_text_format_lib.sh
5. https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit