Template engine for (currently) Jira and Email. Uses yaml and jinja2. It helps you create multiple (possibly cross-linked) jira issues and emails from a template.
Project description
Intro
Template engine for (currently) Jira and Email. Uses yaml and jinja2. It helps you create multiple (possibly cross-linked) jira issues and emails from a template.
Table of Contents
Installation
Windows
- Download Workflow_Templater_${version}.exe from the latest release on Releases page.
- Install it.
- Now
workflow-templater
executable should be available from Windows Command Prompt (cmd.exe
).
macOS
- Install python ≥ 3.7.
- Using official Python installer:
- Install python ≥ 3.7 from https://python.org/ ("macOS 64-bit installer")
- Install CA certificates for python, execute in Terminal:
Alternatively, you can double-click on/Applications/Python\ 3.7/Install\ Certificates.command
Install Certificates.command
in Finder
- Or using Homebrew:
brew install python
- Using official Python installer:
-
pip3 install workflow-templater
Anything else (GNU/Linux, Cygwin, *nix, etc)
Using pip
- Make sure that python ≥ 3.7 is installed
-
pip3 install workflow-templater
Using eggsecutable
- Download workflow_templater-${version}-py3.x.egg from the latest release on Releases page.
- You can execute it directly or with
/bin/sh
(if you have compatible python and dependencies installed):./workflow_templater-${version}-py3.x.egg --help sh ./workflow_templater-${version}-py3.x.egg --help
From source
- Clone this repo
- Install dependencies if required
pip3 install -r requirements.txt
- You can execute the script directly:
Or install/build/whatever it withcd workflow_templater ./workflow_templater/__init__.py --help
python3 setup.py
Usage
See
workflow-templater --help
Configuration
To avoid typing same command line arguments each time, it is possible to specify them in configuration file. Configuration file location is OS-specific, to find out correct location for your os, execute workflow-templater --help
, you'll see message "--config CONFIG overwrite config file path, default is ${location}" where ${location} is the location of configuration file on your OS. You can create this file and specify values of command-line arguments omitting --
and replacing -
with _
, for example, --jira-user j_wayne
becomes jira_user: j_wayne
, --dry-run
becomes dry_run: true
and so on. You can also use jinja2 in configuration file which evaluates using variables from itself.
Example ~/.config/workflow-templater/config.yaml
:
dry_run: true
verbose: true
user: j_wayne
jira: https://jira.example.com/
jira_user: '{{ user }}'
email_user: '{{ user }}'
email_from: '{{ user }}@example.com'
email_smtp: 'smtp.example.com:587'
# avoid typing in the same password for jira and email
jira_keyring_service_name: 'MyCorp LDAP'
email_keyring_service_name: 'MyCorp LDAP'
Template description
Overview
- Whole workflow template is a directory.
- There should be one file with variables named
0_common.yaml
,00_common.yaml
orcommon.yaml
. - There may be any amount of "issue" files: ending with ".jira.yaml" for jira issue and ending with ".email.yaml" for email.
- Each "issue" file is yaml file where each string value is rendered with Jinja2 using variables from
*common.yaml
file.
Examples
See basic release example for basic example.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for workflow_templater-0.1.1-py3.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2fdf98fc8e56c099652e74bf51d95f4bd78685a5a2fd96929093653c0498f4a |
|
MD5 | 1e77b2c5693be1919e3ec37cf32588c2 |
|
BLAKE2b-256 | fdd7f414a3c4be3bcb4232e953daf598098fbd2aec6e39a2ac303d7dc7398cd2 |
Hashes for workflow_templater-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1801ec4ab65b0905934f535a336ef45b04f0b95473f7644923957d1742bc8886 |
|
MD5 | b8b2cee332dab2a136ab168e197cf48d |
|
BLAKE2b-256 | 0146759bdce0d358529e9d3c65b745e96b8283662b49b9adf75cc8c972bdb3c4 |