Merge pull request #60 from dvklopfenstein/dev

Documentation; minor speed; simplify stop defaults

Author: dvklopfenstein

.github/workflows/pylint.yml

@@ -1,11 +1,27 @@
 # pylint
+# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
 name: Pylint
 
 on: [push]
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    #permissions:
+      # actions: none
+      # attestations: none
+      # checks: none
+      #contents: read
+      # deployments: none
+      # id-token: write|none
+      # issues: none
+      # models: read|none
+      # discussions: none
+      #packages: read
+      # pages: none
+      # pull-requests: read
+      # security-events: none
+      # statuses: none
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]

.github/workflows/pytest.yml

@@ -7,6 +7,22 @@ on: [push, workflow_dispatch]
 jobs:
   build:
     runs-on: ubuntu-latest
+      #permissions:
+        # actions: none
+        # attestations: none
+        # checks: none
+        #contents: read
+        # contents: read|write
+        # deployments: none
+        # id-token: write|none
+        # issues: none
+        # models: read|none
+        # discussions: none
+        #packages: read
+        # pages: none
+        # pull-requests: read
+        # security-events: none
+        # statuses: none
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 # Summary
 * [**Unreleased**](#unreleased)
+* [**Release 2025-06-28 v0.8a0**](#release-2025-06-28-v08a0) Documentation; minor speed; simplify stop defaults
 * [**Release 2025-06-21 v0.7a0**](#release-2025-06-21-v07a0) Much added functionality for invoicing
 * [**Release 2025-05-27 v0.6a0**](#release-2025-05-27-v06a0) Added functions to collect various groups of csv files
 * [**Release 2025-05-18 v0.5a7**](#release-2025-05-18-v05a7) Add starttime to `report`; Bug fix in `cancel`
@@ -32,6 +33,10 @@
 
 ## Unreleased
 
+## Release 2025-06-28 v0.8a0
+* CHANGED Starttime object for minor import speed improvement
+* `trk stop -m msg` message be specified 
+
 ## Release 2025-06-21 v0.7a0
 * ADDED command, `trk invoice`
 * ADDED command option, `-b` or `--billable` to `trk stop`
@@ -40,6 +45,7 @@
   will be printed in the invoice
 * ADDED `trk stop -b` or `trk stop --billable` to add 'Billable' tag with minimum typing
 * ADDED `--no-git-add` and `-A` options to the `trk init` command
+* CHANGED speed to 100x faster for parsing free text into datetime objects
 * CHANGED "Run `trk init`" message so it is clearer that no trk command
   will be run until the project is initialized
 * CHANGED imports to improve speed

README.md

@@ -6,6 +6,12 @@
 <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14803225.svg" alt="DOI"> |
 <img src="https://img.shields.io/github/license/dvklopfenstein/timetracker" alt="License">
 </h3>
+<pre align="center" style="font-family: monospace; font-size: larger; border: 1px solid #ccc; padding: 10px; display: inline-block;">
+┌────────────────────────────┐
+│ 🕒 Timetracker CLI Tool    │
+│ Track time → CSV → pandas  │
+└────────────────────────────┘
+</pre>
 </p>
 
 ---

makefile

@@ -1,4 +1,5 @@
 MAKEFLAGS := --no-print-directory
+
 PYTHON := python3
 CSV := /home/dvklo/timetrackers/timetracker_trk_dvklo.csv
 

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.7a0"
+version = "0.8a0"
 license = "AGPL-3.0-or-later"
 authors = [
   {name = 'DV Klopfenstein, PhD', email = 'dvklopfenstein@protonmail.com'},

tests/test_dateparser.py

@@ -23,19 +23,19 @@ def test_dateparser():
     print(f'{base}: RELATIVE_BASE Wed Jan 1, 2025')
     print(f'{date}: "{timestr}"')
 
-    # UNCOMMENT WHEN FIX IS RELEASED:
+    # UNCOMMENT WHEN dateparser FIX IS RELEASED:
     #   https://github.com/scrapinghub/dateparser/pull/1274
-    ##assert date == datetime(2024, 12, 29, 9), (
-    ##    f'GitHub issue https://github.com/scrapinghub/dateparser/issues/1266\n'
-    ##    f'{CALSTR}\n'
-    ##    'If today  is Wed, Jan 1, 2025;\n'
-    ##    f'then "{timestr}" is Sun, Dec 29, 2024\n\n'
-    ##    f'EXP: "2024-12-29 09:00:00"\n'
-    ##    f'ACT: "{date}"'
-    ##    )
-
-    # THIS IS INCORRECT, BUT THAT IS WHAT COMES OUT
-    assert date == datetime(2024, 1, 29, 9)
+    assert date == datetime(2024, 12, 29, 9), (
+        f'GitHub issue https://github.com/scrapinghub/dateparser/issues/1266\n'
+        f'{CALSTR}\n'
+        'If today  is Wed, Jan 1, 2025;\n'
+        f'then "{timestr}" is Sun, Dec 29, 2024\n\n'
+        f'EXP: "2024-12-29 09:00:00"\n'
+        f'ACT: "{date}"'
+        )
+
+    # THIS IS INCORRECT, BUT THAT IS WHAT COMES OUT WITH OLD dateparser
+    #assert date == datetime(2024, 1, 29, 9)
 
 
 if __name__ == '__main__':

timetracker/__init__.py

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

timetracker/cli.py

@@ -9,7 +9,6 @@
 #print(f'{timedelta(seconds=default_timer()-tic)} TOP OF CLI: IMPORT dt')  # PRT
 
 from sys import argv as sys_argv
-#from sys import exit as sys_exit
 from os import getcwd
 #from os.path import exists
 #from logging import debug
@@ -27,8 +26,6 @@
 #print(f'{timedelta(seconds=default_timer()-tic)} TOP OF CLI: AFTER CfgFinder')  # PRT
 #from timetracker.cmd.none import cli_run_none
 #print(f'{timedelta(seconds=default_timer()-tic)} TOP OF CLI: AFTER cli_run_none')  # PRT
-from timetracker.proc import get_log1
-#print(f'{timedelta(seconds=default_timer()-tic)} TOP OF CLI: AFTER get_log1')  # PRT
 
 #print(f'{timedelta(seconds=default_timer()-tic)} TOP OF CLI: AFTER IMPORTS')  # PRT
 
@@ -105,9 +102,6 @@ def _init_args(self, arglist):
             from sys import exit as sys_exit
             print(f'trk {__version__}')
             sys_exit(0)
-        if args.command == 'stop':
-            if args.message == 'd':
-                args.message = get_log1()
         return args
 
     def _init_trksubdir(self):
@@ -122,7 +116,7 @@ def _init_trksubdir(self):
 
     @staticmethod
     def _get_cmds():
-        """In ArgumentParser, usage=f'%(prog)s [-h] {self._get_cmds()}'"""
+        """In argumentparser, usage=f'%(prog)s [-h] {self._get_cmds()}'"""
         # parser.add_subparsers(dest='command', metavar=self._get_cmds(), help=SUPPRESS)
         cmds = ','.join(k for k in FNCS if k != 'invoice')
         return f'{{{cmds}}}'
@@ -203,19 +197,11 @@ def _add_subparser_start(subparsers):
                  'elapsed time(ex: 10min, -10min, 4hr)')
         return parser
 
-    def _get_last_log(self):
-        if self.finder.dirgit:
-            rsp = get_log1()
-            if rsp.stdout != '':
-                return f'({rsp.stdout}); invoked w/`-m d`'
-        return None
-
     def _add_subparser_stop(self, subparsers):
         parser = subparsers.add_parser(name='stop',
             help='Stop timetracking',
             formatter_class=ArgumentDefaultsHelpFormatter)
         parser.add_argument('-m', '--message', required=True, metavar='TXT',
-            default=self._get_last_log(),
             help='Message describing the work done in the time unit')
         parser.add_argument('-k', '--keepstart', action='store_true', default=False,
             #help='Resetting the timer is the normal behavior; Keep the start time this time')

timetracker/starttime.py

@@ -3,13 +3,11 @@
 __copyright__ = 'Copyright (C) 2025-present, DV Klopfenstein, PhD. All rights reserved.'
 __author__ = "DV Klopfenstein, PhD"
 
-from os import remove
+import os
 import os.path as op
-from os.path import exists
 import datetime
-
 from timetracker import consts
-from timetracker.cfg.utils import get_username
+
 
 # 2025-01-21 17:09:47.035936
 
@@ -18,15 +16,15 @@ class Starttime:
 
     min_trigger = datetime.timedelta(hours=10)
 
-    def __init__(self, dircfg, project=None, name=None):
+    def __init__(self, dircfg, project, name):
         self.dircfg  = op.abspath(consts.DIRTRK) if dircfg is None else op.normpath(dircfg)
-        self.project = op.basename(op.dirname(self.dircfg)) if project is None else project
-        self.name = get_username(name) if name is None else name
-        self.filename = op.join(self.dircfg, f'start_{self.project}_{self.name}.txt')
+        self.project = project
+        self.name = name
+        self.filename = op.join(self.dircfg, f'start_{project}_{name}.txt')
 
     def started(self):
         """Return True if the timer is starte, False if not"""
-        return exists(self.filename)
+        return op.exists(self.filename)
 
     def wr_starttime(self, starttime, activity=None, tags=None):
         """Write the start time into a ./timetracker/start_*.txt"""
@@ -44,14 +42,14 @@ def wr_starttime(self, starttime, activity=None, tags=None):
     def get_desc(self, note=' set'):
         """Get a string describing the state of an instance of the CfgProj"""
         return (
-            f'CfgProj {note} {int(exists(self.filename))} '
+            f'CfgProj {note} {int(op.exists(self.filename))} '
             f'fname start {self.filename}')
 
     def rm_starttime(self):
         """Remove the starttime file, thus resetting the timer"""
         fstart = self.filename
-        if exists(fstart):
-            remove(fstart)
+        if op.exists(fstart):
+            os.remove(fstart)
 
     def read_starttime(self):
         """Read the starttime"""