Squashed commit of the following:

commit 051d0d7d32 Author: Gabriel Falcão <gabriel@nacaolivre.org> Date: Tue Nov 10 13:15:35 2015 -0500 pep8 commit 83b3072ffd Author: Gabriel Falcão <gabriel@nacaolivre.org> Date: Tue Nov 10 13:09:33 2015 -0500 release 0.6.0 commit b40c2d98b2 Author: Gabriel Falcão <gabriel@nacaolivre.org> Date: Tue Nov 10 12:07:06 2015 -0500 supporting swappable delimiters
2015-11-10 15:30:57 -05:00
parent c2f52c4d8d
commit c986da5465
7 changed files with 665 additions and 26 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # couleur - ANSI terminal tool for python, colored shell and other handy fancy features
-__Version 0.5.0__
+__Version 0.6.0__

 __Couleur__ is a handy tool to play around with ANSI features in a
 unix terminal
--- a/couleur/init.py
+++ b/couleur/init.py
@@ -20,11 +20,16 @@ import sys
 import uuid
 import platform

-version = '0.5.0'
+version = '0.6.0'

 from StringIO import StringIO


+class delimiters:
+    DEFAULT = ("#{", "}")
+    SQUARE_BRACKETS = ("[", "]")
+
+
 SUPPORTS_ANSI = False
 for handle in [sys.stdout, sys.stderr]:
    if (hasattr(handle, "isatty") and handle.isatty()) or \
@@ -58,40 +63,59 @@ def minify(string):
    return replaced


-def translate_colors(string):
-    for attr in re.findall("[#][{]on[:](\w+)[}]", string):
+def wrapper_factory(delimiter):
+    delimiter_in, delimiter_out = delimiter
+
+    def wrap_escaped(middle_part):
+        din = "".join([r"[{0}]".format(d) for d in delimiter_in])
+        dout = "".join([r"[{0}]".format(d) for d in delimiter_out])
+        return r"".join([din, middle_part, dout])
+
+    def wrap_normal(middle_part):
+        return r"".join([delimiter_in, middle_part, delimiter_out])
+
+    return wrap_escaped, wrap_normal
+
+
+def translate_colors(string, delimiter):
+    wrap_escaped, wrap_normal = wrapper_factory(delimiter)
+
+    for attr in re.findall(wrap_escaped("on[:](\w+)"), string):
        string = string.replace(
-            u"#{on:%s}" % unicode(attr),
+            wrap_normal(u"on:%s") % unicode(attr),
            getattr(backcolors, attr)
        )

-    for attr in re.findall("[#][{](\w+)[}]", string):
+    for attr in re.findall(wrap_escaped("(\w+)"), string):
        string = string.replace(
-            u"#{%s}" % unicode(attr),
-            getattr(forecolors, attr, "#{%s}" % attr)
+            wrap_normal(u"%s") % unicode(attr),
+            getattr(forecolors, attr, wrap_normal("%s") % attr)
        ).replace(
-            u"#{%s}" % unicode(attr),
-            getattr(modifiers, attr, "#{%s}" % attr)
+            wrap_normal(u"%s") % unicode(attr),
+            getattr(modifiers, attr, wrap_normal("%s") % attr)
        )

    return minify(string)


-def ignore_colors(string):
-    up_count_regex = re.compile(ur'[#][{]up[}]')
+def ignore_colors(string, delimiter):
+    wrap_escaped, wrap_normal = wrapper_factory(delimiter)
+
+    up_count_regex = re.compile(wrap_escaped(ur'up'))
    up_count = len(up_count_regex.findall(string)) or 1

-    expression = u'^(?P<start>.*)([#][{]up[}])+(.*\\n){%d}' % up_count
+    expression = (u'^(?P<start>.*)(' + wrap_escaped('up') + u')(.*\\n){%d}') % up_count
    up_supress_regex = re.compile(expression, re.MULTILINE)
+
    string = up_supress_regex.sub('\g<start>', string)

-    for attr in re.findall("[#][{]on[:](\w+)[}]", string):
-        string = string.replace(u"#{on:%s}" % unicode(attr), u"")
+    for attr in re.findall(wrap_escaped("on[:](\w+)"), string):
+        string = string.replace(wrap_normal(u"on:%s") % unicode(attr), u"")

-    for attr in re.findall("[#][{](\w+)[}]", string):
+    for attr in re.findall(wrap_escaped("(\w+)"), string):
        string = (string
-                  .replace(u"#{%s}" % unicode(attr), u"")
-                  .replace(u"#{%s}" % unicode(attr), u""))
+                  .replace(wrap_normal(u"%s") % unicode(attr), u"")
+                  .replace(wrap_normal(u"%s") % unicode(attr), u""))

    return string

@@ -102,7 +126,7 @@ class Writer(StringIO):

    def write(self, string):
        f = self.translate and translate_colors or ignore_colors
-        self.original.write(f(string))
+        self.original.write(f(string, self.delimiter))


 class StdOutMocker(Writer):
@@ -114,21 +138,22 @@ class StdErrMocker(Writer):


 class Proxy(object):
-    def __init__(self, output):
+    def __init__(self, output, delimiter=delimiters.DEFAULT):
        self.old_write = output.write
+        self.delimiter = delimiter

        if output is sys.__stdout__:
-            output = StdOutMocker()
+            output = StdOutMocker(delimiter)

        elif output is sys.__stderr__:
-            output = StdErrMocker()
+            output = StdErrMocker(delimiter)

        self.output = output

    def ignore(self):
        self.output.translate = False
        if not isinstance(self.output, (StdErrMocker, StdOutMocker)):
-            self.output.write = lambda x: self.old_write(ignore_colors(x))
+            self.output.write = lambda x: self.old_write(ignore_colors(x, self.delimiter))

    def enable(self):
        self.disable()
@@ -139,7 +164,7 @@ class Proxy(object):
        elif isinstance(self.output, StdErrMocker):
            sys.stderr = self.output
        else:
-            self.output.write = lambda x: self.old_write(translate_colors(x))
+            self.output.write = lambda x: self.old_write(translate_colors(x, self.delimiter))

    def disable(self):
        if isinstance(self.output, StdOutMocker):
@@ -152,9 +177,9 @@ class Proxy(object):
 _proxy_registry = {}


-def proxy(output):
+def proxy(output, delimiter=delimiters.DEFAULT):
    if output not in _proxy_registry.keys():
-        _proxy_registry[output] = Proxy(output)
+        _proxy_registry[output] = Proxy(output, delimiter)

    return _proxy_registry[output]

--- a/docs/Makefile
+++ b/docs/Makefile
@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/couleur.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/couleur.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/couleur"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/couleur"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -0,0 +1,366 @@
+# -*- coding: utf-8 -*-
+#
+# couleur documentation build configuration file, created by
+# sphinx-quickstart on Tue Nov 10 11:41:47 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'couleur'
+copyright = u'2015, Gabriel Falcão'
+author = u'Gabriel Falcão'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.6.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.6.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'couleurdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  (master_doc, 'couleur.tex', u'couleur Documentation',
+   u'Gabriel Falcão', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'couleur', u'couleur Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  (master_doc, 'couleur', u'couleur Documentation',
+   author, 'couleur', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = project
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or 'en' if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the Pillow.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. couleur documentation master file, created by
+   sphinx-quickstart on Tue Nov 10 11:41:47 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Couleur - Easy ANSI Coloring for Python
+=======================================
+
+This tool helps you produce nice colored output in your command-line
+applications.
+
+.. toctree::
+   :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/docs/source/usage.rst
+++ b/docs/source/usage.rst
@@ -0,0 +1,14 @@
+Usage
+=====
+
+::
+
+    import sys
+    import couleur
+
+    couleur.proxy(sys.stdout).enable()
+    print "#{bold}#{blue}#{on:black}This is#{normal} a test"
+    couleur.proxy(sys.stdout).ignore()
+
+    print "#{green}#{on:black}This is#{normal} a test"
+    couleur.proxy(sys.stdout).disable()
--- a/test_stdout_filter.py
+++ b/test_stdout_filter.py
@@ -20,6 +20,7 @@ from nose.tools import with_setup, assert_equals

 import couleur

+
 def prepare_stdout():
    if isinstance(sys.stdout, StringIO):
        del sys.stdout
@@ -27,12 +28,14 @@ def prepare_stdout():
    std = StringIO()
    sys.stdout = std

+
 def assert_stdout(expected):
    string = sys.stdout.getvalue()
    sys.stdout.seek(0)
    sys.stdout.truncate()
    assert_equals(string, expected)

+
@with_setup(prepare_stdout)
 def test_output_black_foreground():
    "STDOUT filter output: black foreground"
@@ -44,6 +47,7 @@ def test_output_black_foreground():
    print "#{black}should not be translated"
    assert_stdout('#{black}should not be translated\n')

+
@with_setup(prepare_stdout)
 def test_output_black_on_white_foreground():
    "STDOUT filter output: black foreground on white background"
@@ -55,6 +59,7 @@ def test_output_black_on_white_foreground():
    print "#{black}should not be translated"
    assert_stdout('#{black}should not be translated\n')

+
@with_setup(prepare_stdout)
 def test_output_green_foreground():
    "STDOUT filter output: green foreground"
@@ -66,6 +71,7 @@ def test_output_green_foreground():
    print "#{black}should not be translated"
    assert_stdout('#{black}should not be translated\n')

+
@with_setup(prepare_stdout)
 def test_output_green_and_red_on_white_foreground():
    "STDOUT filter output: green foreground and white on red background"
@@ -77,6 +83,7 @@ def test_output_green_and_red_on_white_foreground():
    print "#{black}should not be translated"
    assert_stdout('#{black}should not be translated\n')

+
@with_setup(prepare_stdout)
 def test_output_stdout_ignoring_output():
    "STDOUT filter output: green foreground and white on red background"
@@ -92,6 +99,7 @@ def test_output_stdout_ignoring_output():
    print "#{black}should not be translated"
    assert_stdout('#{black}should not be translated\n')

+
 def test_integration_with_stdout():
    "STDOUT filter integration"

@@ -100,3 +108,15 @@ def test_integration_with_stdout():
    assert sys.stdout is not sys.__stdout__
    couleur.proxy(sys.stdout).disable()
    assert sys.stdout is sys.__stdout__
+
+
+@with_setup(prepare_stdout)
+def test_output_different_delimiters():
+    "using square brackets as delimiters should work"
+
+    couleur.proxy(sys.stdout, delimiter=couleur.delimiters.SQUARE_BRACKETS).enable()
+    print "[black]Hello Black![reset]"
+    assert_stdout('\033[30mHello Black!\033[0m\n')
+    couleur.proxy(sys.stdout).disable()
+    print "[black]should not be translated"
+    assert_stdout('[black]should not be translated\n')