Merge pull request #67 from dvklopfenstein/dev

Improved reports showing all running timers with brevity and rich info

Author: dvklopfenstein

.timetracker/.gitignore

@@ -0,0 +1 @@
+start_*.txt

.timetracker/config

@@ -0,0 +1,6 @@
+# TimeTracker project configuration file
+
+project = "timetracker"
+
+[csv]
+filename = "./timetracker_timetracker_$USER$.csv"

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 # Summary
 * [**Unreleased**](#unreleased)
+* [**Release 2025-07-15 v0.8a4**](#release-2025-07-15-v08a4) Made options and output more concise
 * **Release 2025-07-04 v0.8.3** Clean README
 * [**Release 2025-06-28 v0.8a1**](#release-2025-06-28-v08a1) Added the command `trk running`
 * [**Release 2025-06-28 v0.8a0**](#release-2025-06-28-v08a0) Documentation; minor speed; simplify stop defaults
@@ -34,9 +35,13 @@
 # Details
 
 ## Unreleased
+
+## Release 2025-07-15 v0.8a4
+* CHANGED `trk running` output to be more concise
 * ADDED short option '-d' to original long option '--csvdir' in command, 'trk init'
 * ADDED new script, `timecalc` that takes two of: starttime, stoptime, or timedelta and
   returns the missing datetime or timedelta
+* ADDED documentation for `trk running`
 
 ## Release 2025-06-28 v0.8a1 - 2025-07-04 v0.8a3
 * CHANGED: README cleanup and added links

README.md

@@ -38,7 +38,7 @@ plain text [CSV](https://www.datarisy.com/blog/understanding-csv-files-use-cases
 * **Freedom**: Libre Software (aka open-source)
 * **Simple**: Quick to set up
 * **Privacy**: Own your data
-* **Anti-stalking**: NO invasive tracking ever of keystrokes, browser activity, mouse-clicks, etc.,
+* **Anti-stalking**: No invasive tracking ever of keystrokes, browser activity, mouse-clicks, etc.,
 as is done by multitudinous other timetracking apps
 * **Human-and-machine-readable**: ASCII data stored in CSV (comma-separated values) [plaintext](http://www.markwk.com/plain-text-life.html) files:
   * Ready for [pandas](https://pandas.pydata.org/), the Python Data Analysis Library for tabular data

makefile

@@ -113,6 +113,7 @@ clean:
 	rm -f *.docx
 	rm -f .timetracker_starttime
 	rm -f *.cfg
+	rm -f timetrials_datatime.csv
 
 clobber:
 	make clean

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "timetracker-csv"
 description = "Pandas-friendly time tracking from the CLI"
-version = '0.8.3'
+version = '0.8.4'
 license = "AGPL-3.0-or-later"
 authors = [
   {name = 'DV Klopfenstein, PhD', email = 'dvklopfenstein@protonmail.com'},

timetracker/__init__.py

@@ -2,6 +2,6 @@
 
 __copyright__ = 'Copyright (C) 2025-present, DV Klopfenstein, PhD. All rights reserved'
 __author__ = 'DV Klopfenstein, PhD'
-__version__ = '0.8.3'
+__version__ = '0.8.4'
 
 # Copyright (C) 2025-present, DV Klopfenstein, PhD. All rights reserved

timetracker/cmd/common.py

@@ -88,9 +88,10 @@ def _prtmsg_basic(startobj, dta, hms, force):
 
 def _prt_started_n_running(startobj, dta, hms):
     """Return a string detailing how long the timer has been running"""
-    msg = startobj.str_elapsed_hms(
+    msg = startobj.str_elapsed_ymdhms(
           hms,
-          f'Timer started on {dta.strftime(FMTDT_H)} and running')
+          (f'Timer started {dta.strftime(FMTDT_H)} {startobj.str_info()}\n'
+           'Timer running'))
     print(msg)
 
 # ---------------------------------------------------------
@@ -100,7 +101,7 @@ def prt_elapsed(startobj, pretxt='Timer running;'):
     if (dtstart := startobj.read_starttime()) is not None:
         if (hms := startobj.hms_from_startfile(dtstart)) is not None:
             msg = f'{pretxt} started {dtstart.strftime(FMTDT_H)}; running'
-            print(startobj.str_elapsed_hms(hms, msg))
+            print(startobj.str_elapsed_ymdhms(hms, msg))
         else:
             from timetracker.msgs import str_not_running
             print(str_not_running())

timetracker/cmd/running.py

@@ -7,7 +7,6 @@
 from timetracker.cfg.cfg import Cfg
 from timetracker.cfg.doc_local import get_docproj
 from timetracker.cmd.common import str_uninitialized
-from timetracker.consts import FMTDT_H
 
 
 def cli_run_running(fnamecfg, args):
@@ -33,9 +32,9 @@ def _show_running(cfg_glb, uname, verbose):
                (startobj := doc.get_startobj(uname)) is not None and \
                 startobj.started():
                 if (dta := startobj.read_starttime()):
-                    print(startobj.str_elapsed_hms(
-                          startobj.hms_from_startfile(dta),
-                          f'Timer started on {dta.strftime(FMTDT_H)} and running'))
+                    hms = startobj.hms_from_startfile(dta)
+                    # Began Tue 2025-07-15 11:56:17 AM -> H:M:S
+                    print(f'Began {startobj.str_started(dta)} -> {startobj.str_running(hms)}')
                     if verbose:
                         print(f'    {dirname(dirname(pcfg))}\n')
                     runcnt += 1

timetracker/starttime.py

@@ -72,9 +72,26 @@ def hms_from_startfile(self, dtstart):
         """Get the elapsed time starting from time in a starttime file"""
         return datetime.datetime.now() - dtstart if dtstart is not None else None
 
-    def str_elapsed_hms(self, hms, msg):
-        """Get a string describing the elapsed time"""
-        return f"{msg} H:M:S {hms} for '{self.project}' ID={self.name}"
+    def str_elapsed_ymdhms(self, hms, msg):
+        """Get a string describing the elapsed time: YYYY-MM-DD HH:MM:SS"""
+        ##return f"{msg} H:M:S {hms} for '{self.project}' ID={self.name}"
+        return f"{msg} H:M:S {hms}"
+
+    def str_started(self, dta):
+        """Get a string describing the elapsed time: HH:MM:SS"""
+        ##return f"{msg} H:M:S {hms} for '{self.project}' ID={self.name}"
+        return dta.strftime(consts.FMTDT_H)
+
+    def str_running(self, hms, rm_useconds=True):
+        """Get a string describing the elapsed time: HH:MM:SS"""
+        ##return f"{msg} H:M:S {hms} for '{self.project}' ID={self.name}"
+        if rm_useconds:
+            hms = hms - datetime.timedelta(microseconds=hms.microseconds)
+        return f"H:M:S {hms} by {self.name} for {self.project}"
+
+    def str_info(self):
+        """Get a string with the project, username, and csv filename"""
+        return f'on `{self.project}` by `{self.name}`'
 
 
 # Copyright (C) 2025-present, DV Klopfenstein, PhD. All rights reserved.