Skip to content

jvrsantacruz/dicto

BranchesTags

Repository files navigation

Dicto

Text template processor for message generation

dictō
Latin (verb) 1. repeat, say often. 2. dictate (to someone for writing). 3. compose, express in writing.

Renders custom templates for recurrent text generation such as emails, changelogs, or notifications, fetching data from several sources such as git, chef, redmine... Integrated, configurable and extensible through templates.

  • Usable command line interface, designed for humans.
  • Lots of remote resources offering interesting domain, management and infrastructure information, from several external applications such as git, redmine, mercurial, chef, apt repositories, external commands...
  • Use your custom Jinja2 templates
  • Configurable through yaml files, defining a profile based system, allowing for different multiple complex configurations to be easily used, reused and shared.

Commands

Dicto has two main commands: view, which renders a template to the standard output, and shell, which opens an interactive interpreter with the same exact context the template would use to render.

dicto view

dicto view renders templates to the standard output using external data:

dicto view --profile duataric_email

Hemos cerrado en pruebas duasql v10.16.9

| Proyecto      |  duasql |
|-------------- | ----------------|
| Versión       | v10.16.9  |
| Fecha         | 2015-07-06 |
| Planificación | [redmine/versions/v10.16.9](http://redmine/versions/1244) |
| Documentación | [docs/docs/duasql/v10.16.9](http://docs/docs/duasql/v10.16.9) |

Los cambios incluyen:

* **Errores** ([#15432](http://http://redmine/issues/15432)) Mensaje de discrepancia para duas edi export y Transito

The next example will show a use case for generating a changelog using external info from a Redmine resource:

1. Define a template using available Redmine info along with some basic template vars (current_date) and some user defined ones (codename):

(./changelog.tpl.rst)

.. changelog::
    :version: {{redmine_version.name}}
    :released: {{current_date.date()}}

    `{{codename}} <{redmine_version.url}>`_

    {{redmine_version.description}}

    Changes:

    {% for issue in redmine_issues %}
        .. change::
        :tags: {{issue.tracker.name|lower}}
        :tickets: {{issue.id}}

        {{issue.subject}}
    {% endfor %}
  1. Generate the result, accessing Redmine using user credentials:
dicto view --redmine\
             --redmine-url http://redmine\
             --redmine-version v10.16.9 \
             --redmine-project duataric \
             --template changelog.tpl.rst \
             --data codename:Zarzaparrilla
Enter redmine user: jsl
Enter redmine password:

.. changelog::
    :version: v10.16.9
    :released: 2015-07-06

    `Zarzaparrilla  <{redmine_version.url}>`_

    Bugfixing release

    Changes:

        .. change::
        :tags: errores
        :tickets: 15432

        Mensaje de discrepancia para duas edi export y Transito

Dicto shell

dicto shell fetches all context data needed for template rendering and opens a interactive shell having those variables available for direct use, exploration and experimentation.

It is recomendable to have IPython installed for an enhanced interpreter experience.

dicto shell --profile dua
Enter redmine password:
Enter redmine version: v10.17.1
  __/   .  __  -/- _,_
_(_/(__/__(_,__/__(_/

Template rendering interactive context.

Available vars:
 profile, apt_url, template, redmine_project, redmine_user, redmine_issues,
 current_date, redmine, redmine_url, file, apt_packages, redmine_api, data,
 redmine_version

In [1]: redmine_version.
redmine_version.container_all     redmine_version.post_create       redmine_version.redmine_version
redmine_version.container_create  redmine_version.post_update       redmine_version.refresh
redmine_version.container_filter  redmine_version.pre_create        redmine_version.requirements
redmine_version.container_one     redmine_version.pre_update        redmine_version.save
redmine_version.container_update  redmine_version.project           redmine_version.sharing
redmine_version.created_on        redmine_version.query_all         redmine_version.status
redmine_version.description       redmine_version.query_create      redmine_version.translate_params
redmine_version.id                redmine_version.query_delete      redmine_version.updated_on
redmine_version.internal_id       redmine_version.query_filter      redmine_version.url
redmine_version.is_new            redmine_version.query_one
redmine_version.name              redmine_version.query_update

If available, the ipython package will be used, for a much nicer experience over the standard python shell. To install ipython use: pip install ipython.

Configuration

All accepted command line arguments and options can be set in the configuration file to avoid typing they again. In the file, keys and values under the default key will be used as command line arguments.

This configuration file would allow to run the changelog example without arguments:

default:
    redmine: true
    redmine_user: jsl
    redmine_url: http://redmine
    redmine_version: v10.16.9
    template: changelog.tpl.rst
    data:
        codename: Zarzaparrilla

Profiles

Profiles are named groups of options that can be reused. They can be defined as groups of key, value options under a name within the profiles section.

profiles:
    email:
        redmine: true
        redmine_user: jsl
        template: email.tpl.html

They can be referenced and applied from the command line using the --profile NAME option.

dicto view --profile email

Default locations

The configuration can be specified to dicto via command line:

dicto --config /pat/to/cfg.yaml view (..)

from an environment variable:

export DICTO_CONFIG=/path/to/cfg.yaml

from a default location. dicto will search for a configuration file in default paths in the following order order:

  • local: ./.dicto.yaml: Local config file. A file named .dicto.yaml in the current directory.
  • project: ./.dicto/config.yaml Project config directory. A directory called .dicto in the current directory with a config.yaml file inside.
  • home: ~/.dicto/config.yaml: Home config directory. A directory called .dicto in the user directory and file named config.yaml inside. The user directory refers to the $HOME directory in Linux and Mac OS X, and see the possible locations for Windows. It is possible to override this location by setting the $DICTO_HOME environment variable.

Overriding arguments:

Command line arguments might be set in the default section of the config.yaml file; the profile section of the same file, can define the option again and override it. The program will take the value from the config file unless it gets defined first in an environment variable. The user can always override all of the previous values by setting the option in the command line, which takes precedence over all the rest.

All the different ways of defining the same option, more important first:

  1. command line argument (--template)
  2. environment variable (dicto_TEMPLATE)
  3. profile config file section
  4. default config file section

Resources

The tool bundles in several default data resources. Each of them tries to obtain as much information as possible from a resource and make it available in the context of user defined templates.

Redmine

Fetches project, version and all closed issues from a given Redmine project version. The following variables are available to use within the template:

  • redmine_api: api object with general Redmine data.
  • redmine_project: project object with the specified Redmine project data.
  • redmine_version: version object with the specified Redmine version data.
  • redmine_issues: List of issue objects with the list of open issues in the project at given version.

Use redmine_key along with the Redmine user token, which can be found in http://redmine/my/account to use the API without having to type your password or set it on the command line.

Datatypes:

See also:

Mercurial

Fetches all repository info, commits, tags and commits within a version. The following variables are available to use within the template:

  • hg_repo: api object with general mercurial info and operations.
  • hg_tags: List of all tags objects in the repository.
  • hg_commits: List of all commits within the repository in log order.
  • hg_version_tag: Tag object specified in hg_version.
  • hg_version_commits: List of all commits between the tag in hg_version and the previous one (if any).

Datatypes:

  • tag: namedtuple (name, rev, node, islocal)
  • commit: namedtuple rev, node, tags (space delimited), branch, author, desc, datetime

See also:

Chef

Fetches chef repository info about environments and nodes. The following variables are available to use within the template:

  • chef_envs: dict of environments by name.
  • chef_nodes: dict of nodes by name.

Datatypes:

  • Environment: See environment object in the chef plugin documentation. Each env has a name attribute, attributes dict, override_attributes dict.
  • Node: See `node object in the chef plugin documentation. Each node has name, chef_environment, run_list and attributes, override dict, default dict, automatic dict.

See also:

Apt

Fetches package names and urls from an aptitude repository for some packages. The following variables are available to use within the template:

  • apt_packages: dict by name of of dicts with data for each package.

Datatypes:

  • apt_packages: Each dict contains name, url and a versions list. The versions list contains dicts with name, url, date and size sorted by version (name).

Git

Fetches all repository info, commits, tags and commits within a version. The following variables are available to use within the template:

  • git_repo: api object with general git info and operations.
  • git_tags: List of all tags objects in the repository.
  • git_commits: List of all commits within the repository in log order.
  • git_version_tag: Tag object specified in git_version.
  • git_version_commits: List of all commits between the tag in git_version and the previous one (if any).

Datatypes:

  • tag: See TagReference object in the GitPython documentation. It has a name attribute.
  • commit: See Commit object in the GitPython documentation. It has author, hexsha, name_rev, summary and message attributes.

See also:

Other resources

The user can add extra data using the --data key:value and --file key:path options. Using those options, one or many variables can be set in the template context. --data will add the literal value as given in the command line. --file will open the given path read a file and put its contents in the variable. In case of reusing a key, --data prevails over --file.

eg:

dicto view --data author:jsl \
           --data env:production \
           --file version:version.txt \
           --template mytemplate.tpl.txt

The previous command would add the author, env and version to mytemplate.tpl.txt rendering context and so they can be used within the template.

Templates

All output can be personalized by the user using custom Jinja2 template files. See the template designer documentation for more information about the available syntax and functions.

Usage

Base command:

Usage: dicto [OPTIONS] COMMAND [ARGS]...

Options:
--version      Show the version and exit.
-v, --verbose  Level of verbosity  [default: 0]
--config PATH  Path to the config.yaml file envvar: DICTO_CONFIG
--help         Show this message and exit.

Commands:
view

Common options for view and shell:

Options:
--file TEXT               Extra data from a text file in key:path format.
                            Reads the whole file. Can be used multiple times
--profile TEXT            Name of an existing profile in config to load
                            options from.
--template PATH           Path to a Jinja2 template.
--exe TEXT                Extra data from external program output.
                            key:command format. Can be used multiple times
--data TEXT               Extra data in key:value format. Can be used
                            multiple times.
--redmine-key TEXT        redmine user's key token envvar: REDMINE_KEY
--redmine-password TEXT   redmine user's password envvar: REDMINE_PASSWORD
--redmine-version TEXT    redmine project version envvar: REDMINE_VERSION
--redmine-project TEXT    redmine project slug evvar: REDMINE_PROJECT
--redmine-user TEXT       redmine username envvar: REDMINE_USER
--redmine-url TEXT        redmine application base url envvar: REDMINE_URL
--redmine / --no-redmine  enable/disable redmine resource (default: false)
--hg-version TEXT         mercurial add tag to the data evvar: HG_VERSION
--hg-repo TEXT            mercurial repository PATH/URL envvar: HG_REPO
--hg / --no-hg            enable/disable mercurial resource (default: false)
--git-version TEXT        Adds git tag to the data  envvar: GIT_VERSION
--git-repo TEXT           mercurial repository PATH/URL  envvar: GIT_REPO
--git / --no-git          enable/disable git resource (default: false)
--apt-packages TEXT       apt packages to include.
--apt-url TEXT            apt repository base url envvar: APT_URL
--apt / --no-apt          enable/disable apt resource (default: false)
--chef / --no-chef        enable/disable chef resource (default: false)
-o, --output FILENAME     Writes output to file
-a, --append FILENAME     Appends output to file
-p, --prepend FILENAME    Prepends output to existing file
--help                    Show this message and exit.

Installation

Install dependencies within a virtualenv and then the application itself.

virtualenv env
source env/activate
pip install .

Or from our pypiserver:

$ pip install dicto

Tests

Install tox and use it to run the tests in all environments.

::
pip install tox tox

More tests are to be added to the existing ones.

Collaborate

Open a github issue for bug reports or new ideas. Pull requests are more than welcome!

Roadmap:

  • Plugin interface
  • Move external resources as default plugins
  • More external resources:
    • Github issues
    • Remote git repositories

About

Text template processor for message generation

Resources

Readme
Activity

Stars

1 star

Watchers

2 watching

Forks

1 fork
Report repository

Releases

11 tags

Packages

No packages published

Languages