Skip to main content

A very simple code generator.

Project description

A very simple code generator.

Latest Version Travis CI Status Codecov Status Doc Status


  • Simple and very simple API

  • Custom Jinja Env supported

  • Could be used as Command-Line-Tools

No Template

agen don’t provide any template. It’s only provide some function, to make code to be a template. If you need any public template, please use the awesome open source tool, Cookiecutter .

Why agen?

agen is so lightweight, that could be perfectly integrated into your project in minutes.

I like Cookiecutter (It’s so cool and so awesome), but most of it’s features are too heavyweight for me.


Install with pip:

pip install agen

Install with source code:

cd agen
python install

Quickstart Guide

In agen, use jinja2 as template engine for rendering, so, any feature of jinja2 template will be found in agen .

File Generation

from agen import (

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

> {{key}}

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

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

# Content of

Directory Generation

If we have a directory like this:

└── {{key}}.py

call generate_dir function:

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

will generate


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

Command Line Tool

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]...

  -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 .

Single File

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


Any directory, such as

└── {{key}}.py

both could be source, it also support to use template variable to render the output file name.

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

This command will create a directory named myapp, and processing recursively all files under the directory , output to myapp base on origin structure.


If there is an inner folder in a directory, and the directory has a agen.json or agen.yaml , it will be judged as a Repo

├── agen.json
└── {{name}}
    └── {{name}}.py

The default behavior of this tool will be changed, assuming this Repo

$ agen -s repo -o output -c context.json
  • This command will create a folder has the same name with inner directory to output directory, if the name of folder is a template string, it will be compiled as standard string then create a folder, the other behavior same as directory .

  • The context is not required. If it wasn’t provided, it will load the agen.[json|yaml] file, and prompt user for input.


For context {'key': 'value'}output is current directory, current value:

└── value
Local Template Directory

Use option argument NAMES, could get files path from local templates directory as source . The following two calls are equivalent in *NIX systems:

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


  • Author : Yufei Li

  • Contact me: @yufeiminds (Facebook)、@YufeiMinds (Sina Weibo)


Welcome to develop with me!

Fork this repo & develop it.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agen-0.1.1.tar.gz (9.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page