Awesome
<p align="center"> <a href="#"> <img src="banner.png" alt="Toggl + GitHub Gist" /> </a> </p> <p align="center"> <a href="https://twitter.com/tobimori"> <img src="https://img.shields.io/twitter/follow/tobimori?color=%231da1f2&label=Follow%20%40tobimori&logo=twitter&logoColor=white&style=flat-square" alt="Follow @tobimori on Twitter" /> </a> <a href="#"> <img src="https://img.shields.io/endpoint?logo=toggl&style=flat-square&url=https%3A%2F%2Ftoggl.api.moeritz.io%2Fapi%2Fshields%2F161035819&label=Total%20Time%20Tracked%20Working%20On" alt="Total Time Tracked Working On toggl-box"> </a> </p> <p align="center"> 📊 Update a pinned gist to contain your weekly <a href="https://toggl.com/">Toggl</a> stats. 📊 </p>📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists
🎒 Prep Work
- Create a new public GitHub Gist (https://gist.github.com/)
- Create a token with the
gist
scope and copy it. (https://github.com/settings/tokens/new) - Copy your
API token
from your Toggl profile - Copy your
Workspace ID
from the URL in your project view
🖥 Project Setup
- Fork this repo
- Go to your fork's
Settings
>Secrets
>Add a new secret
for each repository secret (below) - Set filter options in
.github/workflows/schedule.yml
(also below)
🔥 Filter Options
- FILTER_BY_BILLABLE: Filters out specific entries without a specific billable state.
- Valid options:
yes
,no
, orboth
. - Defaults to
both
. - Requires a paid Toggl plan.
- Valid options:
- FILTER_BY_TAG: Filters out specific entries without a specific tag.
- Valid options:
false
to disable the filter,0
to filter out all entries with a tag, or a comma-separated list of tag ids. - Defaults to a random tag id.
- You can get tag ids by utilizing the Toggl API
- Valid options:
- FILTER_BY_USER: Shows only work done by a specific user in a workspace
- Valid options:
false
to disable the filter or a comma-separated list of user ids. - Defaults to a
false
. - You can get user ids by utilizing the Toggl API
- Valid options:
🤫 Repository Secrets
- GIST_ID: The ID portion from your gist url
https://gist.github.com/<github username>/
7887b94cbb97a90fe08498c4744bad4b
. - GH_TOKEN: The GitHub token generated above.
- TOGGL_API_TOKEN: The API key you got from your Toggl profile above.
- TOGGL_WORKSPACE_ID: The ID portion from a workspace-specific Toggl url you copied above, e.g.
https://toggl.com/app/projects/
3295766
/list/
.
✨ Credits
This code was heavily inspired (with some parts taken over) by @jacc's music-box.
📄 License
toggl-box is licensed under the MIT License