tempo-summary-email v0.6.0

Tempo Summary Email

Uses Jira and Tempo apis to create a daily email about work completed.

Installation

Install using NPM:

$ npm install tempo-summary-email

Example

// ES5
const TempoSummaryEmail = require("tempo-summary-email").default;

// ES6
import TempoSummaryEmail from "tempo-summary-email";

const tempoSummaryEmail = new TempoSummaryEmail({
    tempoApiKey: "TEMPO_TOKEN",
    jiraUsername: "user@example.com",
    jiraApiKey: "JIRA_TOKEN",
    jiraDomain: "example.atlassian.net"
});

tempoSummaryEmail.generateEmailForRange("2020-01-01", "2020-01-01")
  .then(response => { 
    console.log(response)
  });

Development

For development this project contains a Dockerfile which can be started using the command:

docker-compose up --build -d

To access the docker container run:

docker-compose exec tempo-summary-email bash

During development it's recommend to run:

npm run watch

This causes any changes done to in typescript to be immediately compiled into javascript.