Getting Started


You will need Python 3.6 or later, including the venv module.

Generally the venv module should come with your default Python install, but not on Ubuntu. On Ubuntu run:

sudo apt-get install python3 python3-venv


git clone
cd flatten-tool
python3 -m venv .ve
source .ve/bin/activate
pip install -r requirements_dev.txt


flatten-tool -h

will print general help information.

flatten-tool {create-template,flatten,unflatten} -h

will print help information specific to that sub-command.

Python Version Support

This code supports Python 3.6 (and later).

Python 3.5 and earlier (including Python 2) are not supported, because they are end of life, and some of the dependencies do not support them.