mirror of
https://github.com/redbluegames/toggl-reporter.git
synced 2026-11-17 01:40:27 +00:00
A collection of utility tools used for miscellaneous tasks
- Python 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .gitignore | ||
| empty-config.yaml | ||
| LICENSE | ||
| README.md | ||
| send-mail.py | ||
| toggl-reporter.py | ||
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.