WorkLog.md#

The hourly command line utility will update the top-level WorkLog.md file when you clock in/out of a project, inserting a clock in/out header with the current time stamp at the top of the file. This file may be edited to add details about the current work session. The WorkLog.md file serves a dual purpose:

  1. It provides a human-readable account of work session details
  2. It ensures there is always a file to commit against

This way work sessions can be documented even if there are no committed code changes.

Collaborative Development#

While simple and convenient for solo projects, there may be merge conflicts if multiple people are updating the same WorkLog. There are at least two ways to work around this:

  1. Use the work_log.filename option to specify an alternate log file (e.g. MyWorkLog.md) in which to store your session details.
  2. Delete your WorkLog.md before merging. Hourly can still generate a timesheet even if the WorkLog.md is missing.

Note

Git keeps the history of your branch's WorkLog after deletion. Recover with git log --all --full-history -- "**/WorkLog.*"

MkDocs#

Currently, the WorkLog is assumed to be in the top level directory of the git project. In order to include work commits in your site's documentation, create a docs/WorkLog.md file containing the following line:

{! WorkLog.md !}

Then update mkdocs.yaml:

nav:
  - WorkLog.md: WorkLog.md

markdown_extensions:
  - markdown_include.include

For example, we can use this method to insert this site's work session details below.

Hourly's WorkLog#

Individual work sessions for the hourly project are documented below.

Note

We have used work_log.header_depth=3 option for clocking in/out so that H3 headers are generated

2020-03-14 20:41:54.111416: clock-out#

  • ENH - can run hourly commands from repo subdirectories
  • test subdir
  • version push
  • testing hourly in subdir

2020-03-14 20:32:40.658394: clock-in#

Sat Mar 14 19:13:06 2020 -0500: clock-out#

  • had to clock out manually during wip

2020-03-14 18:56:34.870426: clock-in#

2020-03-14 16:25:31.198516: clock-out#

  • hydra does not respect os.chdir!

2020-03-14 15:15:20.182542: clock-in#

  • fixing yaml includes for docs

2020-01-29 23:59:37.202116: clock-out#

  • fixed bug preventing users from clocking in

2020-01-29 23:45:29.962519: clock-in#

2020-01-28 20:12:53.326321: clock-out#

  • fixed MANIFEST since cli moved into hourly module

2020-01-28 20:10:17.270214: clock-in#

  • fixed ignore bug preventing timesheet generation
  • 0.3.10
  • changed install path to hourly/cli

2020-01-14 19:02:53.559393: clock-out#

  • 0.3.9
  • fixed timesheet filename bug

2020-01-14 18:47:30.370225: clock-in#

  • 0.3.8

2020-01-14 18:41:10.382420: clock-out#

  • fixed tminus
  • code clean up
  • switching to 'foo' in cfg.bar

2020-01-14 17:32:53.638696: clock-in#

  • pushing version

2020-01-14 02:30:57.609792: clock-out#

  • fixed bugs in invoice generation

2020-01-14 02:03:18.253023: clock-in#

  • trying to figure out submodules

2020-01-14 00:08:15.447796: clock-out#

  • minor doc changes
  • updated remaining docs to reflect hourly-report
  • changed README to reflect new hourly-report syntax
  • fixed bug in invoice generation
  • created hourly-report cli, cleaned up initialization code
  • cli overrides broke grouping
  • fixed bug where command line args were ignored by config_override
  • turned off time sheet generation by default, updated README usage section

2020-01-13 22:01:00.641375: clock-in#

  • changing maxwidth again

2020-01-12 17:20:03.651580: clock-out#

  • changed earnings calculation to dictionary
  • added verbosity setting, error handling
  • moved invoicing code into their own module

2020-01-12 15:11:08.113248: clock-in#

2020-01-12 09:40:04.640256: clock-out#

  • corrected MANIFEST.in path

2020-01-12 09:37:24.327410: clock-in#

  • removing Dashboard prototyping notebook

2020-01-12 09:06:00.564390: clock-out: T-20m#

  • updated README intro

2020-01-12 08:23:25.178670: clock-in#

2020-01-10 20:26:55.510181: clock-out#

2020-01-10 20:23:24.001918: clock-in#

2020-01-10 10:41:14.079277: clock-out#

  • simplifying btcpay setup
  • updated btcpay config docs

2020-01-10 09:11:40.795394: clock-in#

2020-01-09 23:55:09.691335: clock-out#

  • added work graph to WorkLog docs

2020-01-09 23:52:30.625119: clock-in#

2020-01-09 23:30:09.366730: clock-out#

  • actually added MANIFEST.in this time
  • updating docs

2020-01-09 22:22:01.026039: clock-in#

  • corrected invoice notification docs

2020-01-09 11:00:35.544185: clock-out#

  • added MANIFEST.in
  • got hydra.errors.MissingConfigException on mac

2020-01-09 10:34:21.933690: clock-in#

2020-01-09 09:19:01.967756: clock-out#

  • updated usage examples
  • version update

2020-01-09 09:06:20.553382: clock-in#

  • adding stripe screen shot

2020-01-09 03:23:49.529611: clock-out#

  • added further install instructions

2020-01-09 03:22:04.616199: clock-in#

  • updating graph again.. I should really fix this

2020-01-09 02:59:24.294923: clock-out#

  • fixed up requirements

2020-01-09 02:47:45.455102: clock-in#

  • updated press release to include stripe
  • redirected to Authors notes rather than email
  • updating work graph

2020-01-09 02:35:00.616095: clock-out#

2020-01-09 01:16:48.954647: clock-in#

2020-01-09 01:14:18.157882: clock-out: T-10m#

  • anonymized default stripe customer, changed invoice footer
  • yo
  • quieter logging from stripe api
  • kept invoice config from sharing customer data between repos
  • updated requirements.txt to include hydra
  • fixed bug that raised error when only start or end given

2020-01-08 22:28:20.520139: clock-in#

2020-01-08 03:36:04.021070: clock-out#

  • Got stripe integration!
  • Refactored invoice configuration
  • Simplified invoice command: hourly invoice=btcpay or hourly invoice=stripe

2020-01-08 00:05:07.910803: clock-in#

2020-01-07 19:53:09.572565: clock-out#

  • started stripe integration
  • added FAQ

2020-01-07 17:13:47.825366: clock-in: T-13m#

  • updated compensation docs

2020-01-07 02:01:10.275284: clock-out#

  • attending announcement on bitcoinmeister show
  • added documentation on compensation

2020-01-07 01:08:38.620674: clock-in#

  • pushing updated graph
  • set plot hovermode to compare, updated docs

2020-01-07 00:26:37.876624: clock-out#

  • updated docs - added press release

2020-01-07 00:25:01.659294: clock-in: T-35m#

2020-01-06 23:49:06.433811: clock-out#

  • writing hourly blurb for bitcoin&markets newsletter
  • updated configuration README

2020-01-06 23:03:59.405807: clock-in#

  • Need to send blurb to Ansel by friday, mention upwork, write up what you know about tradeoffs with lightning (costs, availability, etc)
  • Need to add a gui and dockerize
  • minor site fixes
  • adding btcpay invoice screenshot
  • fixed typo in docs, updated version
  • touching up documentation
  • updating work graph for hourly repo

2020-01-06 14:52:28.511302: clock-out#

  • merging with master
  • BUGFIX force exit if btcpay-python not installed

2020-01-06 14:48:34.209232: clock-in: T-10m#

2020-01-06 00:57:44.096012: clock-out#

2020-01-05 23:48:31.655464: clock-in: T-25m#

2020-01-05 23:22:17.765638: clock-out#

  • prompting user for confirmation
  • renamed hourly-config.yaml to hourly.yaml

2020-01-05 21:17:55.844445: clock-in#

2020-01-05 20:58:43.148966: clock-out#

  • documenting grouped config

2020-01-05 20:43:23.467637: clock-in#

2020-01-05 17:34:41.710447: clock-out#

  • refactoring configuration using config groups
  • does it make sense to be able to issue an invoice on behalf of someone else?
  • it's the responsibilty of the employer to make sure the invoice their getting is from the right person

2020-01-05 16:29:01.786457: clock-in#

2020-01-05 16:03:22.389791: clock-out#

  • refactoring

2020-01-05 15:32:33.929020: clock-in#

2020-01-05 02:59:59.550127: clock-out#

  • adding user_id to report.filename
  • got hourly to issue first btcpayserver invoice!

2020-01-04 22:59:21.370595: clock-in#

2020-01-04 20:06:20.516946: clock-out#

  • working with pem files
  • changed default max column to match hash length

2020-01-04 18:56:53.105369: clock-in#

2020-01-04 15:35:04.070440: clock-out#

  • moving invoice into cli
  • setting up environment variable interpolation
  • using OmegaConf.to_container(cfg)
  • cannot load a private key from environment variable on windows
  • should probably use a private key file

2020-01-04 13:55:18.699752: clock-in#

2020-01-04 13:01:43.289508: clock-out#

  • testing first invoice

2020-01-04 12:16:11.802771: clock-in#

2020-01-03 21:40:56.858838: clock-out#

  • lightning payments

2020-01-03 19:45:54.790098: clock-in#

2020-01-03 19:31:57.414479: clock-out#

  • looking at btcpayserver
  • trying exitpay https://btc.exitpay.org/
  • found exitpay confirmation email in spam folder

2020-01-03 17:44:04.019146: clock-in#

  • updating graph

2020-01-03 14:28:45.356496: clock-out#

  • addressing helpful hydra hints from Omry
  • documentation improvements

2020-01-03 13:52:35.768769: clock-in#

2020-01-02 18:53:49.974457: clock-out#

  • added ability to group timesheets by name or email or both
  • fixed bug where user can accidentally clock in twice if a non-clock message is committed
  • changed report.outfile to report.filename
  • added multiple users to plot
  • removed click app
  • documentation updates

2020-01-02 14:42:06.286717: clock-in#

2020-01-01 13:52:29.717923: clock-out#

  • adding ability to clock in multiple users

  • check which email address is being used to clock in/out.

  • git config user.email can be used to check which email is configured for the current repo

  • can get name or email from author

2020-01-01 12:25:59.286809: clock-in#

2019-12-31 14:54:48.254974: clock-out#

2019-12-31 14:14:47.319391: clock-in#

2019-12-30 15:23:56.531080: clock-out#

2019-12-30 15:22:44.136505: clock-in#

2019-12-30 15:22:18.590328: clock-out#

  • documentation and hydra code push
  • cleaned up output for clock-in and clock-out messages
  • updated documentation site to reflect move to hydra

2019-12-30 12:17:38.426420: clock-in#

2019-12-29 22:28:23.663515: clock-out#

switching from click to hydra involves some caveats. I really dislike the practice of deprecation, which often breaks things that didn't need fixing. My goal is to minimize that pain for users of the old app. To that end:

  • keep existing cli while in development to ensure behavior can be replicated
  • create a unique (temporary?) name for new app (e.g. myapp-hydra or myapp-cli)
  • replace common flags with separate cli tools. For instance, myapp -myflag becomes myapp-myflag, where myapp-myflag wraps the interface myapp-cli myflag=true

This last one means there is actually one less character to write.

  • added dictConfig_to_dict function to recursively construct nested dict
  • pandas.set_option takes names like display.max_colwidth
  • got hourly-in, hourly-out functional
  • not sure how to make command-line inputs override config_override setting

2019-12-29 19:42:03.967359: clock-in#

2019-12-29 18:02:55.046177: clock-out#

  • developing cli with hydra

2019-12-29 16:34:02.562291: clock-in#

2019-12-26 13:05:03.226272: clock-out#

  • working on refactoring cli with new config
  • adding ability to commit messages without clocking
  • user should not have to directly edit work log

2019-12-26 11:41:13.289307: clock-in#

2019-12-23 13:42:32.292273: clock-out#

  • switching to hydra this changes the cli from hourly -in to hourly commit.clock=in
  • finished up the first iteration of the cli spec!

2019-12-23 12:06:57.928740: clock-in: T-30m#

2019-12-01 13:21:31.816735: clock-out#

  • trying out different plot options
  • looking into configuration setup

2019-12-01 12:50:42.892528: clock-in#

2019-11-30 16:19:45.897554: clock-out#

  • embedding work graph as iframe
  • changing --plot option to specify path/to/work-graph.html

2019-11-30 15:25:51.433329: clock-in#

2019-11-30 15:07:32.727339: clock-out#

  • Testing header depth option

2019-11-30 15:05:34.680440: clock-in#

2019-11-30 14:58:11.651795: clock-out#

  • updating docs
  • added worklog header depth option

2019-11-30 13:53:43.831968: clock-in#

2019-10-23 22:55:48.632734: clock-out#

2019-10-23 21:10:25.808038: clock-in#

2019-09-19 21:47:37.949509: clock-out#

  • Moved time adjustment so it only applies at labor calculation, in clock commits

2019-09-19 21:13:46.261481: clock-in#

2019-09-19 20:43:24.455285: clock-out#

  • pysat contains commits with ROCSAT-1, which breaks time adjustment

2019-09-19 20:33:26.659734: clock-in#

2019-09-19 20:25:52.236443: clock-out#

  • testing on pysat repo

2019-09-19 20:18:01.673816: clock-in#

2019-08-21 01:17:15.009128: clock-out: added plot options#

  • add plot output

2019-08-20 23:21:41.235199: clock-in#

2019-08-14 00:30:48.962283: clock-out#

  • failed to fix utc error when giving only start time

2019-08-14 00:12:41.780463: clock-in: T-7m#

2019-08-14 00:05:12.536012: clock-out#

  • Testing new output for double clock in warning

2019-08-14 00:04:16.778490: clock-in#

2019-08-14 00:04:04.274688: clock-out#

2019-08-14 00:03:57.681741: clock-in: T-1h22m#

2019-08-13 22:40:45.276268: clock-out#

  • bug: negative dt when listing work for one day
  • UTC bug occurs when no end date is specified
  • removed default from wage option
  • Got table into gui

2019-08-13 22:39:42.742055: clock-in#

2019-08-07 23:51:23.947759: clock-out: T-15m#

  • upgrading to python 3.7
  • cleaned up output for when no labor is available
  • prototyping gui
  • bug when date range covers different UTC offsets, which can occur during travel:
2018-10-28 13:44:48-04:00                              clock in  c4e95f59dc0c8ce296a40300760ab6880...
2018-10-28 13:56:35-04:00                             clock out  f5200e718c062e828d436506286fd05e5...
2019-02-25 10:19:10-05:00                        clock in T-1hr  d7add63b4d2e3e1ca1423296aaed25d9c...
2019-02-25 12:49:51-05:00                        clock out T-5m  acfb8596317786e38177345aa25310980...
2019-03-10 22:57:58-04:00                              clock in  217ad6169fbd10efbb1e497a6cc6e4553...
2019-03-11 00:05:42-04:00  clock out - integrating with read...  297a561d5d7c57ecb641fa841d86dc5a6...

2019-08-07 22:01:03.125488: clock-in#

2019-06-19 19:03:19.375329: clock-out#

2019-06-19 18:11:54.185775: clock-in#

2019-06-19 14:56:37.451578: clock-out: T-5m#

  • Weasyprint looks like the easiest path to generating pdfs
  • Look at their invoice example

2019-06-19 14:32:23.261121: clock-in#

2019-06-13 18:36:23.538048: clock-out#

  • Looking at generating invoices in pdf

2019-06-13 18:19:19.036767: clock-in#

2019-04-17 00:21:48.211640: clock-out#

  • got c-lightning server running in container on windows 10
  • had to skip the -u id -u parameter, which means it runs as root
  • have to use docker-machine ip to get the appropriate ip for the windows container

  • got a few of the rest api commands to work, then ran into this:

    Starting bitcoind... waiting for cookie... waiting for RPC... Error: Error: Disk space is low!

  • may need to delete ./data and start again?

2019-04-16 23:06:17.688503: clock-in: researching payments#

2019-04-16 01:21:50.338638: clock-out#

  • Looking into lightning payments https://github.com/ElementsProject/lightning-charge

2019-04-16 00:01:09.069912: clock-in#

2019-04-13 02:43:19.905950: clock-out#

  • Looking into payment automation

  • fixed an errant clock-in/out with hard reset:

    git reset --hard 590804df784c45051c548eb84e930c1157d6acc1

Where I used the last clock-out commit hash from 2019-04-12 18:04:27.744011

2019-04-13 02:24:44.339725: clock-in: T-45m#

2019-04-12 18:04:27.744011: clock-out#

2019-04-12 17:53:58.904877: clock-in: payment options#

2019-04-12 15:45:54.653421: clock-out#

  • determine why report sometimes shows negative time deltas

2019-04-12 15:41:12.003763: clock-in#

2019-04-11 02:48:43.722703: clock-out#

Apr 11, 2019#

  • Finished in/out flags

Apr 8, 2019#

  • working on in/out flags

Apr 7, 2019#

  • Adding "hourly in/out" flags
  • Pushing python 3 version
  • Looking into payment options

Mar 15, 2019#

  • Fixed issue with ignore default

Mar 14, 2019#

  • bug fixing

Mar 12, 2019#

  • scrapping readthedocs in favor of github.io
  • starting command-line interface

Mar 11, 2019#

  • Trying to fix build error

Mar 10, 2019#

  • Added documentation site
  • Started integration with readthedocs

Feb 25, 2019#

  • Added clock adjustments
  • Made match_logs option to raise an error when in/out clocks don't match

Oct 20, 2018#

  • Switched to pd.Timestamp to allow for easier slicing
  • Added timezones
  • Notebook Tutorial runs without errors

Oct 28, 2018#

  • Removed line breaks from repor