Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 3.29 KB

README.md

File metadata and controls

67 lines (51 loc) · 3.29 KB
Raw

Toggl Track Jira Sync

Install

  1. Clone this repository
  2. Install python requirements python3 -m pip install -r requirements.txt
  3. Configure application (see below)
  4. (optional) Setup a regular task to fully automatic sync your tasks

Usage

Start each Toggl entry with a Jira issue reference followed by a slash to enable worklog sync for this time entry.

Example:

MYPROJECT-1337/This text will also be synced to Jira

Just run the sync script to sync all time entries within the configured sync window. This action is idempotent and can be executed multiple times without problems.

Configuration

Configure by setting environment variables or creatng a .env file in the script directory. See .env.example for a template.

Config Default Description
JIRA_URL required Base URL to your Jira Server Instance (e.g. https://jira.example)
JIRA_ACCESS_TOKEN required Jira personal access token. See Jira Docs
JIRA_PROJECT_SLUG required Jira project slug that is considered for sync
TOGGL_URL "https://api.track.toggl.com" Toggl API base URL
TOGGL_API_KEY required Toggl API key. See Toggl Docs
SYNC_WINDOW_SIZE 1 Amount of days, the sync will look in the past

Setup Examples

launchd (MacOS)

  1. Create LaunchAgent config
<!-- /Users/###user###/Library/LaunchAgents/com.github.schlakob.toggl-jira-sync.plist -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>com.github.schlakob.toggl-jira-sync</string>
    <key>ProgramArguments</key>
    <array>
      <string>/opt/homebrew/bin/python3</string>
      <string>/path/to/toggl-jira-sync/sync.py</string>
    </array>
    <key>StartInterval</key>
    <integer>3600</integer>
    <key>StandardOutPath</key>
    <string>/path/to/code/toggl-jira-sync/out.log</string>
    <key>StandardErrorPath</key>
    <string>/path/to/code/toggl-jira-sync/err.log</string>
</dict>
</plist>
  1. Enable and start LaunchAgent
launchctl bootstrap gui/$(id -u) /Users/jdittrich/Library/LaunchAgents/com.github.schlakob.toggl-jira-sync.plist
launchctl kickstart -k gui/$(id -u)/com.github.schlakob.toggl-jira-sync