A very simple way to add color to your Python CLI apps.
- Easy-to-use color class with ANSI escape codes
- Support for foreground and background colors
- Text styling (bold, italic, underline, etc.)
- Simple
colorize()method for quick coloring - Lightweight and dependency-free
pip install mypycolorizerfrom mypycolorizer.colorizer import Color
# Using the colorize method
print(Color.colorize("red", "Hello, World!"))
# Direct ANSI codes
print(f"{Color.GREEN}This is green text.{Color.RESET}")
# Combining styles
color = Color()
print(f"{color.ITALIC}{color.BRIGHT_BLUE}Styled text.{color.RESET}")Foreground Colors:
- BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE
- BRIGHT_BLACK, BRIGHT_RED, BRIGHT_GREEN, BRIGHT_YELLOW, BRIGHT_BLUE, BRIGHT_MAGENTA, BRIGHT_CYAN, BRIGHT_WHITE
Background Colors:
- BLACK_BG, RED_BG, GREEN_BG, YELLOW_BG, BLUE_BG, MAGENTA_BG, CYAN_BG, WHITE_BG
Text Styles:
- BOLD_BRIGHT, DIM, ITALIC, UNDERLINE, BLINK, RAPID_BLINK, REVERSE, HIDE, STRIKETHROUGH
This project welcomes contributions from developers of all skill levels, especially beginners!
- Bug fixes: Found an issue? Fix it!
- New features: Add more colors, styles, or functionality
- Documentation: Improve examples, comments, or this README
- Testing: Add test cases or verify compatibility
- Code improvements: Refactor, optimize, or clean up code
- Fork the repository
- Clone your fork:
git clone https://github.com/yourusername/mypycolorizer.git - Create a branch:
git checkout -b your-feature-name - Make your changes
- Test thoroughly
- Commit:
git commit -m 'Add your feature' - Push:
git push origin your-feature-name - Open a Pull Request
- Keep the code simple and lightweight
- Maintain backward compatibility
- Test with different terminals
- Follow Python best practices
- Add comments for new features
Not all escape codes work with all terminals. Be sure to test your terminal with the styles you would like to use.
mypycolorizer/
├── colorizer.py # Main color class
├── README.md # This documentation
├── CONTRIBUTING.md # Contribution guidelines
└── LICENSE # MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and its documentation files ("the Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software.
THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
You are granted all permissions without any conditions. You do not need to retain, reproduce, or include any copyright notice or a copy of this license when you redistribute the Software.
By choosing to use, copy, or modify the Software in any way, you are agreeing to completely and permanently release the original author(s) from all liability. If anything goes wrong, you are entirely responsible.
END
- Created to simplify terminal coloring in Python
- Inspired by other color libraries but designed for simplicity