Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prashnts/hues
Colored terminal text made easy for Python and happiness.
https://github.com/prashnts/hues
ansi cli color powerline python terminal
Last synced: 3 months ago
JSON representation
Colored terminal text made easy for Python and happiness.
- Host: GitHub
- URL: https://github.com/prashnts/hues
- Owner: prashnts
- License: mit
- Created: 2016-09-09T07:08:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-30T21:44:37.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T06:15:18.284Z (10 months ago)
- Topics: ansi, cli, color, powerline, python, terminal
- Language: Python
- Size: 402 KB
- Stars: 338
- Watchers: 10
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-discoveries - hues - colored terminal text made easy for Python and happiness _(`Python`)_ (Libraries)
- starred-awesome - hues - Colored terminal text made easy for Python and happiness. (Python)
README
# Hues
This is the 90s and your terminal can display _16_ glorious colors.
Your Python scripts deserve the same color love. `Hues` makes printing
to console in color easy. Just grab the package from `PIP`, and your
monochromatic days will be a thing of past!
[](https://travis-ci.org/prashnts/hues) [](https://codeclimate.com/github/prashnts/hues) [](https://pypi.python.org/pypi/hues)
## Quickstart
Go, grab the latest version from PIP. Run:
```bash
pip install hues
```
Then, in your scripts, you can do this:
```python
>>> import hues
>>> hues.log('Mission', 42)
>>> hues.info('Finding', 42)
>>> hues.error(41, 'is not', 42)
>>> hues.warn('We are distracted...')
>>> hues.info('Found', 24)
>>> hues.success('Close enough.')
```
_whoa!_
### Configuration
You can add a `.hues.yml` file in your projects, or your home directory,
overriding the defaults. The configuration files are searched and loaded
in this order:
- Packaged configuration
- User home directory
- Current directory and all the parent directories
Check out the default configuration [here](hues/.hues.yml).
Currently there's a `powerline` theme shipped with the package which
you can enable by updating `theme` value in configuration.
## Creating your own prompts
`hues` makes it easy to create your own custom prompt formats with a
Hue String. Hue string is a thin wrapper around Python strings adding
a chainable syntax that's a joy to use!
```python
>>> import hues
>>> print(hues.huestr(' 42 ').white.bg_blue.bold.colorized)
```
It does exactly what it says:
The Hue string chained attributes use a deterministic pushdown automata
for optimizing the attribute access, so the ANSI escaped strings are
always optimal.
## Colors
All 16 glorious ANSI colors are available for both background and foreground. Assorted text styles such as **`bold`**, _`italics`_ and `underline` are also available. Too many colors? Worry not fam, go to town with `reset` attribute.
## Todo
- [ ] More Documentation.
- [ ] Unicorns required.
Please contribute by opening issues, suggestions and patches.
If you like `hues` or use it in your project, I'd love to hear about it!
Shout at me on [tumblr](//doom.noop.pw) or send me an email.
> Back in my days, we didn't even have colors!