Welcome to mr.bob’s documentation!

Author:Tom Lazar <tom@tomster.org>, Domen Kožar <domen@dev.si> Source code:github.com project Bug tracker:github.com issues License:BSD Generated:January 27, 2015 Version:0.2.dev0

Features

• asks questions which need to be answered to render structure
• questions can be grouped by using a namespace
• renders templates from a folder, Python egg, or zip file
• supports Python 2.6 - 3.3, pypy
• 100% test coverage
• uses Jinja2 as the default rendering engine (can be replaced)
• multiple ways to specify variables to render templates
• preserves permissions when rendering templates
• provides hooks before/after asking a question
• provides hooks before/after rendering structure
• can remember given answers for rendered structure

Flow of mr.bob

Introduction

mr.bob is a tool that takes a directory skeleton, copies over its directory structure to a target folder and can use the Jinja2 (or some other) templating engine to dynamically generate the files. Additionally, it can ask you questions needed to render the structure, or provide a config file to answer them.

mr.bob is meant to deprecate previous tools such as paster (PasteScript) and templer.

• User guide
  • Installation
  • Usage
  • Sample template to try out
  • Listing all questions needed to have corresponding variable for a template
  • Remember answers to a config file
  • Using non-interactive mode
  • Configuration
    • Specifying answers
    • Specifying defaults
    • Remote configuration
    • Configuration inheritance
    • Nesting variables into namespaces called groups
    • mr.bob section reference
  • Collection of community managed templates
• Writing your own template
  • Starting
  • How it works
  • Writing Questions
    • questions section reference
  • Common needs for templating
    • Default value of the question is dynamic
    • Conditionally render a file
    • Based on the answer of the question do something
    • Ask a question based on answer of previous question
  • Hooks
    • Post render hook
    • Pre render hook
    • Pre question hook
    • Post question hook
    • Hooks shipped with mr.bob
  • template section reference
• Design goals
• Why another tool
• Developer guide
  • Setup developer environment
  • Running tests
  • Making a Release
• Source documentation
  • mrbob – Main package
    • mrbob.configurator – Machinery to figure out configuration
    • mrbob.cli – Command line interface
    • mrbob.bobexceptions – Exceptions
    • mrbob.parsing – Parsing .ini files
    • mrbob.rendering – Everything related to rendering templates and directory structure
    • mrbob.hooks – Included hooks
• Changelog
  • 0.2 (unreleased)
  • 0.1.1 (2014-03-03)
  • 0.1 (2014-03-02)
  • 0.1a9 (2013-04-26)
  • 0.1a8 (2013-03-11)
  • 0.1a7 (2013-01-23)
  • 0.1a6 (2013-01-02)
  • 0.1a5 (2012-12-12)
  • 0.1a4 (2012-12-11)
  • 0.1a3 (2012-11-30)
  • 0.1a2 (2012-11-29)
  • 0.1a1 (2012-10-19)

Glossary

dotted notation

Importable Python function specified with dots as importing a module separated with a column to denote a function. For example mrbob.rendering:render_structure

mr.bob

This section configures how mrbob behaves

variables

This section answers to the questions that will be passed to templates for rendering

Indices and tables

• Index
• Module Index
• Search Page