Author: | C.W. |
---|---|
Issues: | http://github.com/moremoban/moban/issues |
License: | MIT |
Version: | |version| |
Generated: | |today| |
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 http://github.com/moremoban/moban.git
$ cd moban
$ python setup.py install
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:
{{hello}}
moban.output will contain:
world
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 -cd CONFIGURATION_DIR, --configuration_dir CONFIGURATION_DIR the directory for configuration file lookup -c CONFIGURATION, --configuration CONFIGURATION 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 .moban.hashes -m MOBANFILE, --mobanfile MOBANFILE custom moban file
- 0 : no changes
- 1 : has changes
- 2 : error occured
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) %} {{line}} {% 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
Test if a file exists or not