PK #2eC"n" " $ pycolorterm-latest/installation.html
At the command line:
$ easy_install pycolorterm
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv pycolorterm
$ pip install pycolorterm
PyColorTerm allows you to write colored and styled lines out in the terminal from Python and in a pythonic way
$ pip install pycolorterm
from pycolorterm.pycolorterm import print_pretty
print_pretty('This is <BOLD>awesome<END> <FG_RED>because<END> you can <UNDERSCORE>mix<END> <BG_BLUE>many styles easily<END>')
To use PyColorTerm in a project
from pycolorterm.pycolorterm import print_pretty
print_pretty('{FG_RED}This is a test in RED')
print_pretty('{FG_RED}This{END} is a {BG_BLUE}{UNDERSCORE}more{END} complex {FG_GREEN}{BOLD}test')
New in version 0.2.1: Changed the markup from {} to <> to allow string pre-formatting
print_pretty('<FG_RED>You can add {}<END>'.format('Variables here'))
from pycolorterm.pycolorterm import pretty_output, styles
with pretty_output(styles['FG_RED']) as out:
out.write('This is a test in RED')
with pretty_output(styles['FG_BLUE']) as out:
out.write('This is a test in BLUE')
with pretty_output(styles['BOLD'], styles['FG_GREEN']) as out:
out.write('This is a bold text in green')
with pretty_output(styles['BOLD'], styles['BG_GREEN']) as out:
out.write('This is a text with green background')
with pretty_output(styles['FG_GREEN']) as out:
out.write('This is a green text with ' + styles['BOLD'] + 'bold' + styles['END'] + ' text included')
with pretty_output() as out:
out.write(styles['BOLD'] + 'Use this' + styles['END'] + ' even with ' + styles['BOLD'] + styles['FG_RED'] + 'no parameters' + styles['END'] + ' in the with statement')
with pretty_output() as out:
out.write('This is {BOLD}awesome{END} {FG_RED}because{END} you can {UNDERSCORE}mix{END} {BG_BLUE}many styles easily{END}'.format(**styles))
None yet. Why not be the first?
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/dnmellen/pycolorterm/issues.
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
PyColorTerm could always use more documentation, whether as part of the official PyColorTerm docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/dnmellen/pycolorterm/issues.
If you are proposing a feature:
Ready to contribute? Here’s how to set up pycolorterm for local development.
Fork the pycolorterm repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/pycolorterm.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv pycolorterm
$ cd pycolorterm/
$ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 pycolorterm tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
Contents: