Skip to content

Commit

Permalink
Document all the options in the readme. Bump version to 0.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
Erik Rose committed Mar 17, 2012
1 parent d176f0f commit b25d7c7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,23 @@ Just do this... ::
...and all your tracebacks will be pretty and helpful.


Options
=======

Traceable is configured by setting environment variables.

``TRACEFRONT_ABSOLUTE_PATHS=1``
Set this to 1 to always use absolute paths rather than ones relative to the
current working directory.
``TRACEFRONT_EDITOR=<editor>``
The editor to use when building editor shortcuts
``TRACEFRONT_FUNCTION_COLOR=<0..15>``
ANSI color number to use for function names in tracebacks
``TRACEFRONT_DIM_COLOR=<0..15>``
ANSI color number to use for de-emphasized text (like editor shortcuts) in
tracebacks


How It Works
============

Expand All @@ -78,7 +95,12 @@ Tracefront is under the MIT License. See the LICENSE file.
Version History
===============

0.1
0.2 (2012-03-17)
* Use terminal codes all the time. (Django uses format_list instead of
print_tb, but I want it to be in color anyway.)
* Document all the options in the readme.

0.1 (2012-03-16)
* Pulled the traceback formatting stuff out of `nose-progressive`_. Barely
tested at all. Will probably erase your drive.

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='tracefront',
version='0.1',
version='0.2',
description='Format tracebacks better.',
long_description=open('README.rst').read(),
author='Erik Rose',
Expand Down

0 comments on commit b25d7c7

Please sign in to comment.