Skip to main content

Command line interface for interacting with Tempo.

Project description

TempoCLI

Command line interface for interacting with Tempo.

PyPI version Python Versions Build Status License Docker Pulls

Introduction

Ease repetitive Tempo tasks by using templates to fill in recurring items without having to use web interface. Templates are yaml formatted files that are semi-flexible in allowing what can be created.

The author_account_id can be obtained by going to your profile in JIRA and copying the ID from the URL.

----
author_account_id: foo

issues:
  # Will use current date if one can't be determined.
  - issue: INT-8
    time_spent: 30m
    start_time: "9:30AM"

  # Can specify day of week easily.
  - issue: INT-10
    time_spent: 1h
    start_time: Monday at 9AM

  # Full on datetime with override.
  - issue: INT-11
    time_spent: 90s
    start_time: "2018-08-05 11:00:00"
    author_account_id: bar

  # Pass in extras that aren't exposed in DSL.
  # https://tempo-io.github.io/tempo-api-docs/#worklogs
  - issue: INT-11
    time_spent: 1h
    start_time: 8am
    extras:
      remainingEstimateSeconds: 300

Installation

$ pip install tempocli

Running

$ tempocli --config <config> create --template <template>

Configuration

By default, ~/.tempocli.yml is the path used for the configuration file but that can be changed with the --config option during invocation. The configuration file should look like this:

---
token: <token>

It is also possible to specify the token using the TEMPOCLI_TOKEN environment variable.

Docker

DockerHub

$ docker run \
    --rm \
    --tty \
    --interactive \
    --volume ~/.tempocli.yml:/home/tempocli/.tempocli.yml:ro \
    --volume /some/dir/with/templates:/templates:ro \
    awiddersheim/tempocli \
    create --template /templates/template.yml

Building Locally

$ docker build --tag tempocli --target prod .

Development

$ pip install --editable .
$ tempocli --help

Testing

# Install development packages (preferably in a virtualenv)
$ pip install --editable .[dev]

# Run tests
$ pytest

# Run tests for available Python interpreters
$ tox

# Linting
$ flake8

# Can also lint in tox as well
$ tox -e flake8

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

tempocli-0.1.dev1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

tempocli-0.1.dev1-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file tempocli-0.1.dev1.tar.gz.

File metadata

  • Download URL: tempocli-0.1.dev1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for tempocli-0.1.dev1.tar.gz
Algorithm Hash digest
SHA256 0a253374fa42861d90a939772e3e4b81e2ea5c42ee89d0818d620eeb5295f85e
MD5 7b51227b7d9ddce2115880654148a1b8
BLAKE2b-256 f376fdeae037e04810d53a13bf879a598735c1fb35ac24ccd08e1ec628e28f94

See more details on using hashes here.

File details

Details for the file tempocli-0.1.dev1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for tempocli-0.1.dev1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d62222d886cb6cdc45de9e58b0c539a5c7e9f7591069b565831f1f9e16c2b349
MD5 af95b6518decb92c8b23af82b1ea5de6
BLAKE2b-256 94fa5a0d31f2751d9c866fc87d0ccdbb101436f8b678bb5f421f706955747e19

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page