Skip to main content

CLI time tracker for What Have You Done?!

Project description

whyd — CLI for What Have You Done?!

Command-line time tracker for What Have You Done?!, with zsh tab completion.

Installation

pip install whyd

Or from source:

git clone https://github.com/xrtic/whyd.git
cd whyd
pip install .

Configuration

Create ~/.whyd/config with your credentials:

mkdir -p ~/.whyd
cat > ~/.whyd/config <<EOF
API_KEY=your-api-key-here
WHYD_URL=https://api.whyd.io/
HOME_DIR=~/.whyd
EOF

Your API key is on the Account page at whyd.io.

You can also override the API key at runtime with the WHYD_API_KEY environment variable:

WHYD_API_KEY=your-key whyd -today

Usage

Time Tracking:
  whyd -n -p <project> -t <duration> -m <message>   Add a time entry
  whyd -s                                            Start the internal timer
  whyd -v                                            View elapsed timer time
  whyd -x                                            Record and reset timer
  whyd -clear                                        Discard the current timer

Reporting:
  whyd -today                List time tracked today
  whyd -week                 List time tracked this week
  whyd -month                List time tracked this month
  whyd -lastmonth            List time tracked last month
  whyd -c <client>           Filter reports by client ID
  whyd -ap                   List all projects/clients (parsable)
  whyd -apt                  List all projects/clients (table)
  whyd -d <n>                Delete entry #n from the last report

Duration format: 1h, 30m, 1h30m

Examples

# Log 90 minutes to a project
whyd -n -p ab12 -t 1h30m -m "Implemented login flow"

# See what you tracked today
whyd -today

# Start a timer, then record it later
whyd -s
whyd -x

zsh Completion

Copy scripts/_whyd to a directory on your $fpath:

cp scripts/_whyd ~/.zsh/completions/_whyd

Make sure that directory is on your fpath in ~/.zshrc:

fpath=(~/.zsh/completions $fpath)
autoload -Uz compinit && compinit

Tab completion covers all flags, and -p completes from your project list, -m from recent messages, and -t from common durations.

Run whyd -refresh to update the local completion caches after adding new projects or clients.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whyd-0.1.1.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whyd-0.1.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file whyd-0.1.1.tar.gz.

File metadata

  • Download URL: whyd-0.1.1.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for whyd-0.1.1.tar.gz
Algorithm Hash digest
SHA256 939b79982c9fbea5871e93f80088da6e24280b0b46b3bf599f1f2bbf995e5e57
MD5 9a97dc16646ae223ea22b2aea2f2c017
BLAKE2b-256 e29719b28a1d71aede6d4e3f541eb744242ce11201cd755038a7a4c98c21601a

See more details on using hashes here.

File details

Details for the file whyd-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: whyd-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for whyd-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b6f042ca025998f2d8897ac945d7c6f1f551cb8e390aaa9edefa0b258ecf076
MD5 c1a268eee59b15ccc710892fc07c48f6
BLAKE2b-256 64a21c6461f9b580573be0010a25fbe438f927bec28bfab7ea8bb70de78b0ae7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page