{ "info": { "author": "Mikhail Khvoinitsky", "author_email": "me@khvoinitsky.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Information Technology", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Topic :: Office/Business :: Scheduling" ], "description": "# Intro\nTemplate 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.\n\n# Table of Contents\n\n\n\n- [Intro](#intro)\n- [Table of Contents](#table-of-contents)\n- [Installation](#installation)\n - [Windows](#windows)\n - [macOS](#macos)\n - [Anything else (GNU/Linux, Cygwin, *nix, etc)](#anything-else-gnulinux-cygwin-nix-etc)\n - [Using pip](#using-pip)\n - [Using eggsecutable](#using-eggsecutable)\n - [From source](#from-source)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Template description](#template-description)\n - [Overview](#overview)\n - [Examples](#examples)\n\n\n\n# Installation\n\n## Windows\n1. Download Workflow_Templater_${version}.exe from the latest release on [Releases page](https://github.com/m-khvoinitsky/workflow-templater/releases).\n2. Install it.\n3. Now `workflow-templater` executable should be available from Windows Command Prompt (`cmd.exe`) and from Powershell.\n4. (Optional, recommended) Install [Windows Terminal](https://github.com/Microsoft/Terminal) and use it instead of default console.\n\n## macOS\n1. Install python \u2265 3.7.\n * Using official Python installer:\n 1. Install python \u2265 3.7 from (\"macOS 64-bit installer\")\n 2. Install CA certificates for python, execute in Terminal:\n ```\n /Applications/Python\\ 3.7/Install\\ Certificates.command\n ```\n Alternatively, you can double-click on `Install Certificates.command` in Finder\n * Or using [Homebrew](https://brew.sh/):\n ```sh\n brew install python\n ```\n2. ```sh\n pip3 install workflow-templater\n ```\n## Anything else (GNU/Linux, Cygwin, *nix, etc)\n### Using pip\n1. Make sure that python \u2265 3.7 is installed\n2.\n ```sh\n pip3 install workflow-templater\n ```\n### Using eggsecutable\n1. Download workflow_templater-${version}-py3.x.egg from the latest release on [Releases page](https://github.com/m-khvoinitsky/workflow-templater/releases).\n2. You can execute it directly or with `/bin/sh` (if you have compatible python and dependencies installed):\n ```sh\n ./workflow_templater-${version}-py3.x.egg --help\n sh ./workflow_templater-${version}-py3.x.egg --help\n ```\n### From source\n1. Clone this repo\n2. Install dependencies if required\n ```sh\n pip3 install -r requirements.txt\n ```\n3. You can execute the script directly:\n ```\n cd workflow_templater\n ./workflow_templater/__init__.py --help\n ```\n Or install/build/whatever it with\n ```\n python3 setup.py\n ```\n\n# Usage\nSee\n```sh\nworkflow-templater --help\n```\n# Configuration\nTo 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.\n\nExample `~/.config/workflow-templater/config.yaml`:\n```yaml\ndry_run: true\nverbose: true\nuser: j_wayne\njira: https://jira.example.com/\njira_user: '{{ user }}'\nemail_user: '{{ user }}'\nemail_from: '{{ user }}@example.com'\nemail_smtp: 'smtp.example.com:587'\n# avoid typing in the same password for jira and email\njira_keyring_service_name: 'MyCorp LDAP'\nemail_keyring_service_name: 'MyCorp LDAP'\n\n```\n\n# Template description\n## Overview\n* Whole workflow template is a directory.\n* There should be one file with variables named `0_common.yaml`, `00_common.yaml` or `common.yaml`.\n* There may be any amount of \"issue\" files: ending with \".jira.yaml\" for jira issue and ending with \".email.yaml\" for email.\n* Each \"issue\" file is yaml file where each string value is rendered with [Jinja2](http://jinja.pocoo.org/docs/templates/) using variables from `*common.yaml` file.\n\n## Examples\nSee [basic release example](https://github.com/m-khvoinitsky/workflow-templater/tree/master/examples/basic_release_example) for basic example.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/m-khvoinitsky/workflow-templater", "keywords": "jira email template workflow release", "license": "", "maintainer": "", "maintainer_email": "", "name": "workflow-templater", "package_url": "https://pypi.org/project/workflow-templater/", "platform": "", "project_url": "https://pypi.org/project/workflow-templater/", "project_urls": { "Homepage": "https://github.com/m-khvoinitsky/workflow-templater" }, "release_url": "https://pypi.org/project/workflow-templater/0.2.0/", "requires_dist": [ "Jinja2", "keyring", "ruamel.yaml", "appdirs" ], "requires_python": "", "summary": "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.", "version": "0.2.0" }, "last_serial": 5832058, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "1e77b2c5693be1919e3ec37cf32588c2", "sha256": "b2fdf98fc8e56c099652e74bf51d95f4bd78685a5a2fd96929093653c0498f4a" }, "downloads": -1, "filename": "workflow_templater-0.1.1-py3.7.egg", "has_sig": false, "md5_digest": "1e77b2c5693be1919e3ec37cf32588c2", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 10067, "upload_time": "2019-07-23T15:46:59", "url": "https://files.pythonhosted.org/packages/fd/d7/f414a3c4be3bcb4232e953daf598098fbd2aec6e39a2ac303d7dc7398cd2/workflow_templater-0.1.1-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "b8b2cee332dab2a136ab168e197cf48d", "sha256": "1801ec4ab65b0905934f535a336ef45b04f0b95473f7644923957d1742bc8886" }, "downloads": -1, "filename": "workflow_templater-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b8b2cee332dab2a136ab168e197cf48d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11033, "upload_time": "2019-07-23T15:46:58", "url": "https://files.pythonhosted.org/packages/01/46/759bdce0d358529e9d3c65b745e96b8283662b49b9adf75cc8c972bdb3c4/workflow_templater-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "31e410d807e3c9ce0ef974b5e23e0adc", "sha256": "bcf05de41c217ca4fecda48adb8a91e502977ad06e69c638ae7040120953dafb" }, "downloads": -1, "filename": "workflow_templater-0.1.1.tar.gz", "has_sig": false, "md5_digest": "31e410d807e3c9ce0ef974b5e23e0adc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9491, "upload_time": "2019-07-23T15:47:00", "url": "https://files.pythonhosted.org/packages/59/91/f46462f435cf14553cc3a0956792031ff6f144184b634ed6c53d3a9db067/workflow_templater-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "8ffdbd73383ed0751511ac36ee4e960a", "sha256": "724bfe7a367babfe45823f1576b725a0db540ea47321b1838ebad698384cef85" }, "downloads": -1, "filename": "workflow_templater-0.2.0-py3.7.egg", "has_sig": false, "md5_digest": "8ffdbd73383ed0751511ac36ee4e960a", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 11493, "upload_time": "2019-09-15T14:04:28", "url": "https://files.pythonhosted.org/packages/16/8b/67e287c9a1848a3bbf69cb0710d0b8f51d7f6db6241b163e93e6702bb014/workflow_templater-0.2.0-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "fc1d7a9b4cae9ed2c048490585d50f2d", "sha256": "3bccf32357178b06f1a68f959764464dd9cd6d6b139eebf331945003ee030b81" }, "downloads": -1, "filename": "workflow_templater-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fc1d7a9b4cae9ed2c048490585d50f2d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12498, "upload_time": "2019-09-15T14:04:26", "url": "https://files.pythonhosted.org/packages/4e/74/4eb3eda2969b834f48b9615402eb8267f39441604c8f4142fc3f564f1fb2/workflow_templater-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "159c7c3223209a578df29a1593f52bc3", "sha256": "8194c45c25457a57aa706cb14f0e39e5f46038af6847c5592b00797d2502efdc" }, "downloads": -1, "filename": "workflow_templater-0.2.0.tar.gz", "has_sig": false, "md5_digest": "159c7c3223209a578df29a1593f52bc3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11899, "upload_time": "2019-09-15T14:04:29", "url": "https://files.pythonhosted.org/packages/d8/1d/208842cfa0682e1e506c60fc262fd8d1076163ede442ba3734638d1f7442/workflow_templater-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8ffdbd73383ed0751511ac36ee4e960a", "sha256": "724bfe7a367babfe45823f1576b725a0db540ea47321b1838ebad698384cef85" }, "downloads": -1, "filename": "workflow_templater-0.2.0-py3.7.egg", "has_sig": false, "md5_digest": "8ffdbd73383ed0751511ac36ee4e960a", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 11493, "upload_time": "2019-09-15T14:04:28", "url": "https://files.pythonhosted.org/packages/16/8b/67e287c9a1848a3bbf69cb0710d0b8f51d7f6db6241b163e93e6702bb014/workflow_templater-0.2.0-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "fc1d7a9b4cae9ed2c048490585d50f2d", "sha256": "3bccf32357178b06f1a68f959764464dd9cd6d6b139eebf331945003ee030b81" }, "downloads": -1, "filename": "workflow_templater-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fc1d7a9b4cae9ed2c048490585d50f2d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12498, "upload_time": "2019-09-15T14:04:26", "url": "https://files.pythonhosted.org/packages/4e/74/4eb3eda2969b834f48b9615402eb8267f39441604c8f4142fc3f564f1fb2/workflow_templater-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "159c7c3223209a578df29a1593f52bc3", "sha256": "8194c45c25457a57aa706cb14f0e39e5f46038af6847c5592b00797d2502efdc" }, "downloads": -1, "filename": "workflow_templater-0.2.0.tar.gz", "has_sig": false, "md5_digest": "159c7c3223209a578df29a1593f52bc3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11899, "upload_time": "2019-09-15T14:04:29", "url": "https://files.pythonhosted.org/packages/d8/1d/208842cfa0682e1e506c60fc262fd8d1076163ede442ba3734638d1f7442/workflow_templater-0.2.0.tar.gz" } ] }