GitHubTimeTracker

GitHubTimeTracker is a python library inspired on StephenOTT / Github-Time-Tracking for tracking time and budget spent on a project.

Installation

pip install git+https://github.com/rdev-hackaton/GitHubTimeTracker

Usage

CLI

GitHubTimeTracker comes with a simple command-line interface. Just type ghtt to enter interactive mode, or toss in a few options to filter the results.

Usage: ghtt [OPTIONS]

  Print time/budget info

Options:
  --token TEXT           Your GitHub personal access token.
  --login TEXT           Your GitHub login (use this or token, not both).
  --password TEXT        Your GitHub password.
  --repo TEXT            Repository.
  --committer TEXT       Limit results to given committer.
  --issue INTEGER        Limit results to commits related to given issue.
  --milestone TEXT       Limit results to commits related to given milestone.
  --total / --non-total  Give total time/budget instead of a list of entries.
  --help                 Show this message and exit.

Time logging

Activities should be prefixed with an amount of time spent on them. The prefix has a few variations:

The line should begin with a clock emoji, and then be followed by d, h or m for days, hours and minutes. Any text after that will be treated as a comment to the time log entry.

You can use this syntax to log time spent on commits, issues, pull requests and so forth.

Authors