Feat: download Toggl detailed time reports as CSV

[thekaveman]

Part of #25

New command

$ compiler-admin time download -h
usage: compiler-admin time download [-h] [--start YYYY-MM-DD] [--end YYYY-MM-DD] [--output OUTPUT]
                                    [--client CLIENT_ID] [--project PROJECT_ID] [--task TASK_ID] [--user USER_ID]

options:
  -h, --help            show this help message and exit
  --start YYYY-MM-DD    The start date of the reporting period. Defaults to the beginning of the prior month.
  --end YYYY-MM-DD      The end date of the reporting period. Defaults to the end of the prior month.
  --output OUTPUT       The path to the file where converted data should be written. Defaults to stdout.
  --client CLIENT_ID    An ID for a Toggl Client to filter for in reports. Can be supplied more than once.
  --project PROJECT_ID  An ID for a Toggl Project to filter for in reports. Can be supplied more than once.
  --task TASK_ID        An ID for a Toggl Project Task to filter for in reports. Can be supplied more than once.
  --user USER_ID        An ID for a Toggl User to filter for in reports. Can be supplied more than once.

Example usage

All defaults

compiler-admin time download

Custom date range

compiler-admin time download --start 2024-09-01 --end 2024-09-30

Custom output file

compiler-admin time download --output /path/to/file.csv

Filter projects

compiler-admin time download --project 1234 --project 5678

Filter users

compiler-admin time download --user 1234 --user 5678

Required .env

An API token and Workspace ID for Toggl are required

TOGGL_API_TOKEN=token
TOGGL_WORKSPACE_ID=workspace

Optional .env

Default filter for a Toggl Client

TOGGL_CLIENT_ID=client

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
compiler_admin
main.py
compiler_admin/commands/time
__init__.py
download.py
compiler_admin/services
toggl.py					90
Project Total

This report was generated by python-coverage-comment-action