frankenstein

Project Templates Brought to Life.

Installation

The easiest way to install frankenstein us to use pip:

pip install frankenstein

Or you can clone the github repo and install from a local version of the code:

git clone git@github.com:thespacedoctor/frankenstein.git
cd frankenstein
python setup.py install

To upgrade to the latest version of frankenstein use the command:

pip install frankenstein --upgrade

Development

If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

git clone git@github.com:thespacedoctor/frankenstein.git
cd frankenstein
python setup.py develop

Pull requests are welcomed!

Issues

Please report any issues here.

Usage

frankenstein <pathToTemplate> <pathToDestination> [-s <pathToSettingsFile>]

-h, --help            show this help message
-s, --settings        the settings file

Documentation

Documentation for frankenstein is hosted by Read the Docs (last stable version and latest version).

Tutorial

Todo

  • add tutorial

Placeholders

The placeholder delimiters can be set in the yaml settings file. If you’re using frankenstein for the first time, a default settings file is added to your home directory for you.

The default placeholders are %% and xxx.

Dyanamic Placeholders

Some placeholders are dynamic and will be pre-populated for you. There include:

  • now-ymd: e.g. 20151001
  • now-hms: e.g. 093103
  • now-ymdhms: e.g. 20151001t093103
  • now-date: e.g. October 1, 2015
  • now-time e.g 9:31 am
  • now-datetime e.g October 1, 2015 9:31 am
  • now-year e.g 2015