Metadata-Version: 2.1
Name: string-color
Version: 0.2.0
Summary: just another mod to print strings in 256 colors in the terminal.
Home-page: https://gitlab.com/shindagger/string-color
Author: Andy Klier
Author-email: andyklier@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: setuptools
Requires-Dist: columnar

# string-color   

string-color is just another python module for coloring strings in print statements.   

### Installation   

`$ pip install string-color`   

### CLI Usage     

```
positional arguments:
  color          show infor for a specific color:
                 $ string-color red
                 $ string-color '#ffff87'
                 $ string-color *grey* # wildcards acceptable

optional arguments:
  -h, --help     show this help message and exit
  -x, --hex      show hex values
  -r, --rgb      show rgb values
  --hsl          show hsl values
  -a, --alpha    sort by name
  -v, --version  show program's version number and exit
```  

`$ string-color`   

display a list of all 256 colors   

`$ string-color yellow`   

show color info for the color yellow   

`$ string-color "#ff0000"`   

show color info for the hex value #ff0000   

`$ string-color *grey*`  

show all colors with "grey" in the name. also works with "grey\*" and "\*grey"  

![CLI Screep Cap][cliscreencap]  

[cliscreencap]: https://believe-it-or-not-im-walking-on-air.s3.amazonaws.com/sc-screen-cap2.jpg  "CLI Screen Cap"  

### Python Module Usage   

```python   
from stringcolor import cs, bold, underline  

# a few examples without background colors.   
# for color names see CLI usage above.   
print(cs("here we go", "orchid"))   
print(cs("away to space!", "DeepPink3"))   
print(cs("final fantasy", "#ffff87"))   

# bold and underline also available.  
print(bold(cs("purple number 4, bold", "purple4")))  
print(underline(cs("blue, underlined", "blue")))  
print(bold(underline(cs("bold AND underlined!", "gold"))))

# yellow text with a red background.   
# color names, hex values, and ansi numbers will work.   
print(cs("warning!", "yellow", "#ff0000"))   
```   

![Usage Screep Cap][screencap]

[screencap]: https://believe-it-or-not-im-walking-on-air.s3.amazonaws.com/sc-screen-cap.jpg "Usage Screen Cap"


