Motif is an opinionated templating toolkit built in Python.
Project description
ap-motif
Motif is an opinionated templating toolkit built in Python
Requirements
- Python 3.8.x, 3.9.x
- Appropriate virtualization
Installation
pip install ap-motif
Usage:
# validate a configuration file
motif validate PATH/TO/CONFIG.YML
# create a new tool via configuration file
motif create PATH/TO/CONFIG.YML
Config File Definition
version: 'VERSION'
config:
namespace: 'NAMESPACE_IDENTIFIER'
name: 'TOOL_NAME'
version: 'MAJOR.MINOR.PATCH'
description: 'DESCRIPTION'
author: 'AUTHOR_NAME'
author_email: 'AUTHOR_EMAIL'
tool: 'TOOL_IDENTIFIER'
tool_specific:
command: 'COMMAND_NAME'
-
VERSION
is the motif config version, currently1.0
-
NAMESPACE_IDENTIFIER
is the name of your python namespace, i.e.ap
for things I create -
TOOL_NAME
is the name of the tool, i.e.motif
-
MAJOR.MINOR.PATCH
is an optional field that defaults to0.1.0
-
AUTHOR_NAME
is the author's name -
AUTHOR_EMAIL
is the author's email (use your github anonymous email for security purposes) -
TOOL_IDENTIFIER
is one of the following:cli
to create a new CLI tool
-
tool_specific
options change based on the tool in questioncli
COMMAND_NAME
is an optional field and will revert to theTOOL_NAME
if not provided. this is the command line command used to execute the tool