0.0
No commit activity in last 3 years
No release in over 3 years
script_summoner creates a template ruby script including command-line parsing and documentation based on a small configuration file.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies
 Project Readme

What does summon do?

summon generates a template ruby script based on a configuration file.
It gets rid of the tedious copying/pasting/figuring-out of option parsing.

How do I use it?

summon example.conf

Status

Embryonic… Will change it as and when I need to. Feel free to fork :-)

Config file format

Configuration file is in YAML format. Example:

—-
name: script_name
author: Jan Aerts
description: This is the description of your script
options:
– short: i
long: infile
example: my_file.txt
default: input.txt
type: String
mandatory: false
description: Input file
– short: o
long: outfile
example: my_outfile.txt
default: output.txt
type: String
mandatory: false
description: Output file

Required keys for each option:

  • long
  • example
  • type
  • description

Optional key for each option:

  • short
  • default
  • mandatory (default = no)
  • type (default = String)