toggl-report

Script to generate pdf report for GULP (Leistungsnachweis)

Motivation: Those, who work together with Gulp, need to provide report at the end of the month with performance records. In case, Toggl tracker is used, the report generation can be automated using current script.

Local install

Install Pipenv

Project use Pipenv as package manager.

> pip install pipenv

Create virtual environment

> pipenv --python 3.8

Install dependencies

> pipenv install

Generate detailed report

Local run

> ./cli.py \
  --api-key {KEY}  \
  --workspace Test \
  --year 5 \
  --month-number 5 \
  --name "Max Mustermann" \
  --project-number Test \
  --client-name "Muster GmbH" \
  --order-no 123456

Run with docker

> make run \
    api_key={KEY} \
    workspace=Test \
    month_number=5 \
    year=5 \
    name="Max Mustermann" \
    project_number="Test" \
    client_name="Muster GmbH" \
    order_no=123456

Result

Development

Lint

> make lint

Tests

> make test