A collection of utility tools used for miscellaneous tasks
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2017-06-01 01:00:13 -04:00
.gitignore Implement PDF report 2017-05-30 00:48:56 -04:00
empty-config.yaml Rename out-of-date 'api_key' in config to 'api_token' 2017-05-31 00:23:05 -04:00
LICENSE Initial commit 2016-03-31 02:15:32 -04:00
README.md Update README.md with client id parameter 2017-06-01 01:00:13 -04:00
send-mail.py Move all files into root 2016-06-03 00:12:26 -04:00
toggl-reporter.py Implement filter by client id 2017-05-31 00:20:51 -04:00

Toggl Reporter

This tool hits the Toggl API and generates reports that I send to the rest of the team via the helper email script.

Currently it only generates a detailed report broken down by project for a given user and date range.

Installation

Install Python

brew install python

Install Python dependencies

pip install pyaml
pip install iso8601
pip install requests

Install Linter (if writing code)

pip install pylint
apm install linter-pylint

Copy the empty-config.yaml file to config.yaml.

cp empty-config.yaml config.yaml

Modify the new file to include your Toggl and Gmail credentials.

Usage

You can run this tool from the command line. Many parameters are obtained from the config file, so make sure you've set that up.

To generate a JOSN report...

python toggl-reporter.py <since> <until>

To generate a PDF report...

python toggl-reporter.py -p <since> <until>

To generate a PDF report for specific clients...

python toggl-reporter.py -pvc CLIENTIDHERE,CLIENTIDHERE 2017-05-01 2017-05-30

To send a report via email...

python send-mail.py

Resources

See the Toggle API docs for more details.