configglue team mailing list archive

[Ricardo Kirkner <ricardo.kirkner@xxxxxxxxxxxxx>]

Ricardo Kirkner has proposed merging lp:~ricardokirkner/configglue/quickstart into lp:configglue.

Requested reviews:
  Configglue developers (configglue)


Overview
========

This branch adds a quickstart guide for getting started. It also lays the ground for documenting configglue with sphinx.
-- 
https://code.launchpad.net/~ricardokirkner/configglue/quickstart/+merge/38749
Your team Configglue developers is requested to review the proposed merge of lp:~ricardokirkner/configglue/quickstart into lp:configglue.

=== modified file '.bzrignore'
--- .bzrignore	2009-06-15 18:23:08 +0000
+++ .bzrignore	2010-10-18 18:29:39 +0000
@@ -6,3 +6,4 @@
 python-build-stamp*
 build
 dist
+doc/_build

=== added directory 'doc'
=== added file 'doc/Makefile'
--- doc/Makefile	1970-01-01 00:00:00 +0000
+++ doc/Makefile	2010-10-18 18:29:39 +0000
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+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 "  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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in 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."
+
+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/configglue.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/configglue.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+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."

=== added directory 'doc/_static'
=== added directory 'doc/_templates'
=== added file 'doc/conf.py'
--- doc/conf.py	1970-01-01 00:00:00 +0000
+++ doc/conf.py	2010-10-18 18:29:39 +0000
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# configglue documentation build configuration file, created by
+# sphinx-quickstart on Wed Oct 13 13:20:17 2010.
+#
+# 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, os
+
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# 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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'configglue'
+copyright = u'2010, John R. Lenton, Ricardo Kirkner'
+
+# 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.9'
+# The full version, including alpha/beta/rc tags.
+release = '0.9pre1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# 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 = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# 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']
+
+# 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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'configgluedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'configglue.tex', u'configglue Documentation',
+   u'John R. Lenton, Ricardo Kirkner', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True

=== added file 'doc/index.rst'
--- doc/index.rst	1970-01-01 00:00:00 +0000
+++ doc/index.rst	2010-10-18 18:29:39 +0000
@@ -0,0 +1,15 @@
+.. configglue documentation master file, created by
+   sphinx-quickstart on Wed Oct 13 13:20:17 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to configglue's documentation!
+======================================
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+
+    intro
+    quickstart

=== added file 'doc/intro.rst'
--- doc/intro.rst	1970-01-01 00:00:00 +0000
+++ doc/intro.rst	2010-10-18 18:29:39 +0000
@@ -0,0 +1,63 @@
+============
+Introduction
+============
+
+What is configglue?
+===================
+
+configglue is a library that glues together Python's  optparse.OptionParser and
+ConfigParser.ConfigParser, so that you don't have to repeat yourself when you
+want to export the same options to a configuration file and a commandline
+interface.
+
+The main features of configglue are:
+
+- ini-style configuration files
+- schema-based configuration
+- commandline integration
+- configuration validation
+
+
+Why would I want to use configglue?
+===================================
+
+Some of the benefits of using configglue are that it allows you to:
+
+- separate configuration declaration (which options are available) from
+  definition (what value does each option take)
+- validate configuration files (there are no required options missing, prevent
+  typos in option names, assert each option value is of the correct type)
+- use standard types out of the box (integer, string, bool, tuple, list, dict)
+- use standards-compatible configuration files (standard ini-files)
+- create your own custom types beyond what's provided in the library 
+- easily support commandline integration
+- override options locally by using several configuration files (useful for
+  separating configuration files for different environments)
+
+configglue and django-configglue are already available in Ubuntu 10.10
+(Maverick), so they can be installed via apt-get. configglue should already be
+installed if you have the desktop edition, as it's being used by Ubuntu One's
+client.
+
+Who else is using configglue?
+=============================
+
+- Ubuntu Pay 
+- Ubuntu Software Center
+- Ubuntu Single Sign On
+- Ubuntu One 
+
+
+Got curious?
+============
+
+You can find a quickstart guide for configglue on 
+:ref:`quickstart` and you can get its code at
+http://launchpad.net/configglue.
+
+As an additional bonus, there is another project called 
+django-configglue which allows you to use all the benefits of configglue on
+your Django projects. You can find a quickstart guide for django-configglue on
+http://packages.python.org/django-configglue and you can get its code at
+http://launchpad.net/django-configglue.
+

=== added file 'doc/quickstart.rst'
--- doc/quickstart.rst	1970-01-01 00:00:00 +0000
+++ doc/quickstart.rst	2010-10-18 18:29:39 +0000
@@ -0,0 +1,156 @@
+.. _quickstart:
+
+configglue 101
+==============
+
+This is a minimalistic step-by-step guide on how to start using configglue to
+manage configuration settings for your application.
+
+Jump in
+-------
+
+Most of the time the code needed to make your application work with configglue
+will look like the following snippet, so let's look at it in detail::
+
+    def main(config, opts):
+        # do something
+        values = config.values('__main__')
+        for opt in ('foo', 'bar'):
+            option = config.schema.section('__main__').option(opt)
+            value = values.get(opt)
+            if value != option.default:
+                print "%s option has been configured with value: %s" % (opt,
+                    value)
+            else:
+                print "%s option has default value: %s" % (opt, option.default)
+
+    if __name__ == '__main__':
+        from configglue.pyschema import (
+            IntConfigOption, BoolConfigOption, Schema, SchemaConfigParser,
+            schemaconfigglue)
+
+        # create the schema
+        class MySchema(Schema):
+            foo = IntConfigOption()
+            bar = BoolConfigOption()
+
+        # read the configuration files
+        scp = SchemaConfigParser(MySchema())
+        scp.read(['config.ini'])
+
+        # support command-line integration
+        op, opts, args = schemaconfigglue(scp)
+
+        # validate the config (after taking into account any command-line
+        # provided options
+        is_valid, reasons = scp.is_valid(report=True)
+        if not is_valid:
+            op.error(reasons[0])
+
+        # run
+        main(scp, opts)
+
+Let's start at the top.
+
+You'll probably have a *main* function that you'll be calling to get
+your application started.
+
+::
+
+    def main(config, opts):
+        # do something
+        ...
+
+    if __name__ == '__main__':
+        ...
+        # run
+        main(scp, opts)
+
+So, for configglue to deliver it's awesomeness, all the magic has to happen
+before calling your *main* function.
+
+The general structure is:
+
+#. Create a schema for your configuration
+
+    ::
+
+        class MySchema(Schema):
+            foo = IntConfigOption()
+            bar = BoolConfigOption()
+
+#. Create a parser for that schema
+
+    ::
+
+        scp = SchemaConfigParser(MySchema())
+
+#. Read the configuration files (to get the statically defined configuration
+   values)
+
+    ::
+
+        scp.read(['config.ini'])
+
+#. (Optional) Weave in command-line integration support (so that configuration
+   options can be overridden via command-line)
+
+    ::
+
+        op, opts, args = schemaconfigglue(scp)
+
+#. (Optional) Validate the effective configuration (to capture any
+   configuration issues)
+
+    ::
+
+        is_valid, reasons = scp.is_valid(report=True)
+        if not is_valid:
+            op.error(reasons[0])
+
+Test
+----
+
+To test our configglue support, let's try out different use cases.
+
+#. Default values
+
+    ::
+
+        $ python app.py
+        foo option has default value: 0
+        bar option has default value: False
+
+#. Config file
+
+    Write the following content to a file called *config.ini*::
+
+        [__main__]
+        bar = true
+
+    and then run
+
+    ::
+
+        $ python app.py
+        foo option has default value: 0
+        bar option has been configured with value: True
+
+#. Command-line integration
+
+    ::
+
+        $ python app.py --foo=2
+        foo option has been configured with value: 2
+        bar option has been configured with value: True
+
+    .. note:: This output is assuming you still have the *config.ini* file you
+        created during the previous use case.
+
+
+Profit!
+-------
+
+That's it! Your application now uses configglue to manage it's configuration.
+Congratulations!
+