File Generation

from agen import (
    string_render,
    render,
    generate,
    generate_dir
)

# Render text from a templated string
string_render('{{key}}', {'key': 'value'})
> 'value'

cat template.py
> {{key}}

# Render text from a template file
render('template.py', {'key': 'value'})
> 'value'

# Generate file from a template file
generate('template.py', 'output.py', {'key': 'value'})

# Content of output.py
value

Directory Generation

If we have a directory like this：

directory
├── __init__.py
└── {{key}}.py

call generate_dir function：

generate_dir('directory', 'mydir', {'key': 'value'})

will generate

mydir
├── __init__.py
└── value.py

Every pure text file will be render by template engine. context {'key': 'value'} also will be rendered automatically.

Basic Usage

agen also implement a very simple command line tool, use for rendering the local template easily, but it only could be used on *UNIX operation system.

Usage: agen [OPTIONS] [NAMES]...

Options:
  -o, --out PATH      Output path or directory
  -s, --source PATH   Source path or directory
  -c, --context PATH  Path of context file
  --help              Show this message and exit.

With no argument，agen will search local template directory, eg. on *NIX operation system, this directory are usually at:

$ agen
--------------------------------------------
  agen Library
  see -> /Users/yufeili/.agen/templates
--------------------------------------------
directory   repo        single.txt

The simplest way to call：

$ agen -s template_path -o ouput_path -c context.json

Sure, .yaml also can be used as context file. If the out option wasn’t provided, it will prompt for input on screen (defualt is current directory).

Full Example

You can specific three kinds of directory or file as the source .

$ agen -s single.txt -o output.txt -c context.json

directory
├── __init__.py
└── {{key}}.py

$ agen -s directory -o myapp -c context.json

repo
├── README.md
├── agen.json
└── {{name}}
    ├── __init__.py
    └── {{name}}.py

$ agen -s repo -o output -c context.json

.
└── value
    ├── __init__.py
    └── value.py

$ agen -s ~/.agen/templates/single.txt
$ agen single.txt