moban - 模板 Yet another jinja2 cli command for static text generation
Generated:Jan 14, 2019

moban brings the high performance template engine (JINJA2) for web into static text generation. It is used in pyexcel project to keep documentation consistent across the documentations of individual libraries.


You can install it via pip:

$ pip install moban

or clone it and install it:

$ git clone
$ cd moban
$ python install

Quick start

Here is a simple example:

$ moban -c data.yml -t my.template
$ cat moban.output

Given data.yml as:

hello: world

and my.template as:


moban.output will contain:


the tutorial has more use cases.


usage: moban [-h] [-cd CONFIGURATION_DIR] [-c CONFIGURATION]
             [-td [TEMPLATE_DIR [TEMPLATE_DIR ...]]] [-t TEMPLATE] [-o OUTPUT]
             [-f] [-m MOBANFILE]

Yet another jinja2 cli command for static text generation

optional arguments:
  -h, --help            show this help message and exit
                        the directory for configuration file lookup
                        the dictionary file
  -td [TEMPLATE_DIR [TEMPLATE_DIR ...]], --template_dir [TEMPLATE_DIR [TEMPLATE_DIR ...]]
                        the directories for template file lookup
  -t TEMPLATE, --template TEMPLATE
                        the template file
  -o OUTPUT, --output OUTPUT
                        the output file
  --template_type TEMPLATE_TYPE
                        the template type, default is jinja2
  -f                    force moban to template all files despite of
  -m MOBANFILE, --mobanfile MOBANFILE
                        custom moban file

exit codes

  • 0 : no changes
  • 1 : has changes
  • 2 : error occured

Built-in Filters


It breaks down the given string into a fixed length paragraph. Here is the syntax:

{% for line in your_string | split_length(your_line_with) %}
{% endfor %}

It is used to keep changelog formatted in CHANGELOG.rst.jjs in pypi-mobans project


It expands simple hashtags into github issues. Here is the syntax:

{{ your_github_string | github_expand }}

It makes it easy to mention github reference in change log in all projects. Here is the place it is applied: CHANGELOG.rst.jjs in pypi-mobans project

Here is Grammar in the changelog.yml:

=============== ==============================
Syntax          Meaning
=============== ==============================
`#1`            moban issues 1
`PR#1`          moban pull request 1
`pyexcel#1`     other project issues 1
`pyexcel#PR#1`  other project pulll request 1
=============== ==============================

More details can be found in moban’s changelog.yml


Returns a single quoted string in the templated file

Built-in Tests


Test if a file exists or not


Please clone the moban repository as the data mentioned in the tutorial are stored in examples folder.

In pratice, the following use cases were found interesting to go along with.

For more complex use case, please look at its usage in pyexcel project

Change log

0.2.4 - 14-07-2018


  1. #32: option 1 copy a directory without its subdirectories.
  2. #30: command line template option is ignore when a moban file is present

0.2.3 - 10-07-2018


  1. #76: running moban as a module from python command
  2. #32: copy a directory recusively
  3. #33: template all files in a directory

0.2.2 - 16-06-2018


  1. #31: create directory if missing during copying


  1. #28: if a template has been copied once before, it is skipped in the next moban call

0.2.1 - 13-06-2018


  1. templates using the same template engine will be templated as a group
  2. update lml dependency to 0.0.3

0.2.0 - 11-06-2018


  1. #18: file exists test
  2. #23: custom jinja plugins
  3. #26: repr filter
  4. #47: allow the expansion of template engine
  5. #58: allow template type per template


  1. #34: fix plural message if single file is processed

0.1.4 - 29-May-2018


  1. #21: targets become optional
  2. #19: transfer symlink’s target file’s file permission under unix/linux systems
  3. #16: introduce copy key word in mobanfile

0.1.3 - 12-Mar-2018


  1. handle unicode on python 2

0.1.2 - 10-Jan-2018


  1. #13: strip off new lines in the templated file

0.1.1 - 08-Jan-2018


  1. the ability to present a long text as multi-line paragraph with a custom upper limit
  2. speical filter expand github references: pull request and issues
  3. #15: fix templating syntax to enable python 2.6

0.1.0 - 19-Dec-2017


  1. #14, provide shell exit code

0.0.9 - 24-Nov-2017


  1. #11, recognize .moban.yaml as well as .moban.yml.
  2. #9, preserve file permissions of the source template.
  3. -m option is added to allow you to specify a custom moban file. kinda related to issue 11.


  1. use explicit version name: moban_file_spec_version so that version can be used by users. #10 Please note: moban_file_spec_version is reserved for future file spec upgrade. For now, all files are assumed to be ‘1.0’. When there comes a new version i.e. 2.0, new moban file based on 2.0 will have to include ‘moban_file_spec_version: 2.0’

0.0.8 - 18-Nov-2017


  1. #8, verify the existence of custom template and configuration directories. default, are ignored if they do not exist.


  1. Colorize error messages and processing messages. crayons become a dependency.

0.0.7 - 19-Jul-2017


  1. Bring the visibility of environment variable into jinja2 templating process: #7

0.0.6 - 16-Jun-2017


  1. added ‘-f’ flag to force moban to template all files despite of .moban.hashes


  1. moban will not template target file in the situation where the changes occured in target file than in the source: the template file + the data configuration after moban has been applied. This new release will remove the change during mobanization process.

0.0.5 - 17-Mar-2017


  1. Create a default hash store when processing a moban file. It will save unnecessary file write to the disc if the rendered content is not changed.
  2. Added summary reports

0.0.4 - 11-May-2016


  1. Bug fix #5, should detect duplicated targets in .moban.yml file.

0.0.3 - 09-May-2016


  1. Bug fix #4, keep trailing new lines

0.0.2 - 27-Apr-2016


  1. Bug fix #1, failed to save utf-8 characters

0.0.1 - 23-Mar-2016


  1. Initial release

Indices and tables